X-Git-Url: https://plomlompom.com/repos/?p=redo-blog;a=blobdiff_plain;f=README.md;h=b7f03dd4ccb5cc319f40028e113dffa4a0ccb9ce;hp=80b13e80b117b5d80f6c5af5f9f18bcd535a6e66;hb=f88948caf952c4fd913ea7466c2f1ab3455af506;hpb=72e91a2e5600566eae283d427450fa1c2fe4969b diff --git a/README.md b/README.md index 80b13e8..b7f03dd 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,19 @@ 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. -(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 and can be edited to customize +the blog: ./metadata/url, ./metadata/author, ./metadata/uuid, ./metadata/title.) + +bugs +---- + +Don't create a index.rst or index.md in the redo-managed directory, that will +break things.