Add HTML templating, extend tests.

[redo-blog] / README.md

diff --git a/README.md b/README.md
index 54029dea8266a961e51639f9b906b7aef6956530..9d6a05b17e7cbffe92d6f62d90315fa5f8724102 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,40 @@
-# redo-blog
+redo-blog
+=========
+
 small blog system using the redo build system
+
+dependencies
+------------
+
+- redo
+- python3
+- uuidgen
+- html2text
+- pandoc
+
+testing
+-------
+
+Run ./test.sh.
+
+setup
+-----
+
+To set up a directory with symbolic links to the relevant files in ./processor/,
+run ./add_dir.sh DIRECTORY.
+
+You can then enter the directory and run redo there. This will generate article
+.html files from all .md and .rst files, plus a ./index.html, and a ./feed.xml.
+These files will be linked to symbolically in a directory ./public/.
+
+Some metadata files will also be generated below ./metadata/: For each article,
+there will be generated a .uuid and a .intermediate file; furthermore, files for
+data used in ./feed.xml and ./index.html will be built there and can be edited
+to customize the blog – namely the files url, author, uuid, title, index.tmpl,
+index_snippet.tmpl, article.tmpl.
+
+bugs
+----
+
+Don't create a index.rst or index.md in the redo-managed directory, that will
+break things.