X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=README.md;h=20b3becc33e3e035b0ae4410eb48446f265cb7a1;hb=4373137de8ac6ad8731e6828a9876de9efe0a82e;hp=54029dea8266a961e51639f9b906b7aef6956530;hpb=41db49b35f4622e7caa7aecd9b814d8a760fc259;p=redo-blog

diff --git a/README.md b/README.md
index 54029de..20b3bec 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,37 @@
-# 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.
+(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.) 
+
+bugs
+----
+
+Don't create a index.rst or index.md in the redo-managed directory, that will
+break things.