X-Git-Url: https://plomlompom.com/repos/?p=redo-blog;a=blobdiff_plain;f=README.md;h=9d6a05b17e7cbffe92d6f62d90315fa5f8724102;hp=ac71a90a0a452c511cbf45d61b989324db70021c;hb=6b5631096b03f1c985bc40c4d2e244315280c686;hpb=14735771a6f38a0c875cb6908ead5a4d24fbfc48 diff --git a/README.md b/README.md index ac71a90..9d6a05b 100644 --- a/README.md +++ b/README.md @@ -25,17 +25,16 @@ 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.) +These files will be linked to symbolically in a directory ./public/. + +Some metadata files will also be generated below ./metadata/: For each article, +there will be generated a .uuid and a .intermediate file; furthermore, files for +data used in ./feed.xml and ./index.html will be built there and can be edited +to customize the blog – namely the files url, author, uuid, title, index.tmpl, +index_snippet.tmpl, article.tmpl. 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 oder index.md in the redo-managed directory, -that will also break things. +Don't create a index.rst or index.md in the redo-managed directory, that will +break things.