home · contact · privacy
Remove the last remainder of germanness
[redo-blog] / README.md
index 7177f956bd1d5eb57efd03a8dded95b8b0fe6da6..92047da94629eb39e998266eea9d46180a276f54 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,8 +20,8 @@ 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.
@@ -27,3 +29,13 @@ You can then enter the directory and run redo there. This will generate article
 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
+----
+
+Due to bad shell scripting in ./processor/index.html.do and
+./processor/feed.xml.do (see the FIXME notes there), source files whose names
+contain "$" break the redo processing.
+
+Oh, and don't create a index.rst or index.md in the redo-managed directory,
+that will also break things.