summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuke Shumaker <lukeshu@sbcglobal.net>2017-01-02 16:28:02 -0500
committerLuke Shumaker <lukeshu@sbcglobal.net>2017-01-02 16:28:02 -0500
commit3c80bf7cc1bd61f8c9edf4806f1e57611ba29fdd (patch)
treea2173204928324454d450054422accee582300db
parentacffe1eea8ed015e26cc6e9178e3b4bc9ab8bb96 (diff)
write a bit of HACKING.md
-rw-r--r--HACKING.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/HACKING.md b/HACKING.md
index 1333ed7..8783b0e 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -1 +1,13 @@
-TODO
+Here's the gist:
+
+ /src/ : website content
+ /bin/ : programs and such for generating the website from /src/
+ /out/ : where the generated output goes
+ Makefile : invoke /bin/ as appropriate
+ git-setup : set up git hooks (see below)
+
+The web server should serve the union of /src/ and /out/.
+
+On `master`, /out/ is ignored. But `git-setup` will set up a git
+post-commit hook to generate /out/, and commit it to the
+`pre-generated` branch.