From 8c77207d8672408afb32bee5a97c0b93b8033b03 Mon Sep 17 00:00:00 2001
From: Case Duckworth
Date: Mon, 18 Mar 2024 10:11:17 -0500
Subject: Update README

Still need to finish ... whatever
---
 README.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 83 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 57417a5..1a55ef6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,84 @@
-## Source Code Htmlizer Written in Awk
+# Source Code Htmlizer Written in Awk
 
-Hey guess what loser, it's a source code htmlizer written in awk.
+Here we have a tool that's in a similar vein to [stagit][] and others.  It takes a number of files on the commandline and generates HTML for them in an output directory, then generates an index with a file listing and a readme.  It's also written completely in awk(1p).  I guess that's the gimmick.
+
+[stagit]: https://codemadness.org/stagit.html
+
+## How to use
+
+I don't want to figure out how to process actual command-line arguments in awk, so I've made all the configuration doable through awk variables.  The command I've been running to test `schwa` is
+
+```sh
+./schwa.awk -vreadme=README.md \
+	-vreadmefilter='pandoc -thtml5' \
+	-vtemplate=template.html \
+	-vstatic=style.css \
+	-vclone=https://foo.bar/schwa \
+	-vdesc="Source Code Htmlizer" \
+	*
+```
+
+Of course, some explanation is in order.
+
+### Command-line variables
+
+template
+: *needs documentation*
+
+out
+: *needs documentation*
+
+readme
+: *needs documentation*
+
+readmefilter
+: *needs documentation*
+
+clone
+: *needs documentation*
+
+desc
+: *needs documentation*
+
+static
+: *needs documentation*
+
+### Templating
+
+CLONE
+: *needs documentation*
+
+DESCRIPTION
+: *needs documentation*
+
+DIRECTORY
+: *needs documentation*
+
+FILENAME
+: *needs documentation*
+
+OUTFILE
+: *needs documentation*
+
+RAWFILE
+: *needs documentation*
+
+CONTENT
+: *needs documentation*
+
+#### "Conditionals"
+
+`<!--INDEX--> ... <!--/INDEX-->`
+: *needs documentation*
+
+`<!--NORMAL--> ... <!--/NORMAL-->`
+: *needs documentation*
+
+## Contributing
+
+Email me at <git@acdw.net> to contribute.
+
+## License
+
+This project is licensed under a BSD 3-clause license.
+See COPYING for more details.
-- 
cgit 1.4.1-21-gabe81