commit 016a5d70945f42f44ae7084f91cb556112bc6139 (patch)
Author: Alex Karle <firstname.lastname@example.org>
Date: Tue, 14 Jul 2020 00:09:37 -0400
doc: Update README with better descriptions of the site(s)
I figured it's worth documenting the stagit setup more-or-less (if only
for my future reference).
Plus, "soap box" is one word -- can't leave that around!
1 file changed, 27 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -1,6 +1,32 @@
-My soap box on the internet.
+My small corner of the internet.
A static site with a small templating system, build with `make`.
+Currently hosted with OpenBSD's `httpd`, but any web server should be able to
+serve it up.
+I use a simple setup of git-daemon for anonymous (read-only) downloads,
+ssh+git for read+write access (limited to myself) and [stagit] to host static
+views into the diffs and files of each repo.
+I like the stagit approach in that it is simple, modular, and emphasizes the use
+of regular git for larger operations (i.e. diff between refs, etc).
+In the stagit/ directory, find:
+ * style.css -- CSS for all pages
+ * post-receive -- the git-hook to update the pages
+ * logo.png -- AK logo
+ * setup.sh -- small script to setup all exported repos with proper hooks, etc
+ also used to bulk update style.css/post-receive/logo.png
+The content, being static, is served up with `httpd` as well.