X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=README.md;h=20b3becc33e3e035b0ae4410eb48446f265cb7a1;hb=4373137de8ac6ad8731e6828a9876de9efe0a82e;hp=7177f956bd1d5eb57efd03a8dded95b8b0fe6da6;hpb=53bf0e25ffc5f0851889ce712a5b9a6e9554e413;p=redo-blog diff --git a/README.md b/README.md index 7177f95..20b3bec 100644 --- 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,9 @@ 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 +---- + +Don't create a index.rst or index.md in the redo-managed directory, that will +break things.