Add HTML templating, extend tests.

[redo-blog] / README.md

diff --git a/README.md b/README.md
index 7177f956bd1d5eb57efd03a8dded95b8b0fe6da6..9d6a05b17e7cbffe92d6f62d90315fa5f8724102 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,9 +6,11 @@ small blog system using the redo build system
 dependencies
 ------------
 
+- redo
 - python3
 - uuidgen
 - html2text
+- pandoc
 
 testing
 -------
@@ -18,12 +20,21 @@ Run ./test.sh.
 setup
 -----
 
-To set up a directory with symbolic links to the relevant .do files and other
-important files, run ./add_dir.sh DIRECTORY.
+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.
-(Some other metadata files will also be generated: for each article, there will
-also be generated a .uuid and a .intermediate file; furthermore, files with
-metadata used in ./feed.xml and ./index.html will be built and can be edited to
-customize the blog: ./url, ./author, ./uuid, ./title.) 
+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.