X-Git-Url: https://plomlompom.com/repos/?p=redo-blog;a=blobdiff_plain;f=README.md;h=92047da94629eb39e998266eea9d46180a276f54;hp=f304dc0507f91cd071d86d6623fbdb13adc9cdea;hb=40b6e84ca0b49be896d60457b43374ab929d2737;hpb=3efddc2b4c7734cc87c2c5f419ac3402aad7c45d diff --git a/README.md b/README.md index f304dc0..92047da 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ small blog system using the redo build system dependencies ------------ +- redo - python3 - uuidgen - html2text @@ -19,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. @@ -28,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.