X-Git-Url: https://plomlompom.com/repos/%7B%7B%20web_path%20%7D%7D/decks/%7B%7Bdeck_id%7D%7D/cards/%7B%7Bcard_id%7D%7D/static/git-logo.png?a=blobdiff_plain;f=README.md;h=9d6a05b17e7cbffe92d6f62d90315fa5f8724102;hb=6b5631096b03f1c985bc40c4d2e244315280c686;hp=2d06932031dc96789d9a88dd8661c26045fd5ef9;hpb=93be8e855138454b2dc2a1108702abc933209d78;p=redo-blog

diff --git a/README.md b/README.md
index 2d06932..9d6a05b 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,40 @@
-# redo-blog
+redo-blog
+=========
 
 small blog system using the redo build system
 
-dependencies:
+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.