summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorewy <ewy0@protonmail.com>2026-06-14 18:23:44 +0200
committerewy <ewy0@protonmail.com>2026-06-14 18:23:44 +0200
commit936fb0c8676861f1ab15a255018a2bf82fa81aab (patch)
treed0c72f6d0f37f60373d7a7b0c1c2b61346aef02b /README.md
parent40577525de2a01ca0b21a5d88757295ae7735580 (diff)
update web
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index ecf50c8..a69b87b 100644
--- a/README.md
+++ b/README.md
@@ -58,7 +58,9 @@ pik remembers your projects, and you can invoke stuff almost anywhere. to view e
pik reads the first comment line from your targets and informs you in the tui!
-## current features
+## features
+
+Run `pik --help` to view the manpage. It is created at runtime by `pik`, so it is always up to date.
* run targets by their approximate name: `pik build` will trigger `.pik/build.sh`, or `.pik/build.py`, or `make build`
depending on what's possible.
@@ -91,6 +93,9 @@ pik reads the first comment line from your targets and informs you in the tui!
* search with `/` and `?`, scroll results with `n` and `N`
### supported pik runners
+
+these files can be run by invoking them through pik:
+
* python
* shell
* executable files
@@ -98,11 +103,12 @@ pik reads the first comment line from your targets and informs you in the tui!
### supported external runners
+these existing systems can be invoked through pik, meaning you can use pik's call site features (etc.) while still using
+your preferred system.
+
* `just`
* `make`
* `pyproject.toml`
-*
-* if you want any more let me know and it should be done very fast
## planned features