home · contact · privacy
Add some more info to the README.
authorChristian Heller <c.heller@plomlompom.de>
Sat, 19 Nov 2016 14:14:24 +0000 (15:14 +0100)
committerChristian Heller <c.heller@plomlompom.de>
Sat, 19 Nov 2016 14:14:24 +0000 (15:14 +0100)
README.md

index 2d06932..7177f95 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,29 @@
-# redo-blog
+redo-blog
+=========
 
 small blog system using the redo build system
 
-dependencies:
+dependencies
+------------
+
 - python3
 - uuidgen
 - html2text
+
+testing
+-------
+
+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.
+
+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.)