download patch
commit 3d340c339a03e92c32e92417f85df83b70b550b7
Author: tri <tri@thac.loan>
Date: Sun Sep 28 12:57:42 2025 +0700
add instructions
diff --git a/README.md b/README.md
index 9d891be..691b847 100644
--- a/README.md
+++ b/README.md
is Vietnamese for "showing off", or "boasting".
It's a static site generator for you git repos. Think [stagit][1] but with way fewer features.
-## How
+## Build
-TODO
+We use zig master, which is `0.16.0-dev.393+dd4be26f5` at the time of writing.
+
+```sh
+zig build -Doptimize=ReleaseSafe
+```
+
+Runtime dependencies:
+
+- `git`
+
+## Use
+
+Assuming all of your repos (both normal and bare repos work fine) reside in `/srv/git/repos`, run
+
+```sh
+khoe /srv/git/repos
+```
+
+Said dir is now serveable as a static website. For a quick preview, try `python3 -m http.server -b localhost -d /srv/git/repos`. People can `git clone` repos from this site too.
+
+Please **make sure there's nothing sensitive in your `repos` dir** before exposing it to the unwashed public. Git hooks, config, etc. are the usual suspect.
## License