From: Christian Heller Date: Wed, 25 Jan 2017 02:12:55 +0000 (+0100) Subject: Update README. X-Git-Url: https://plomlompom.com/repos/%7Broute%7D?a=commitdiff_plain;h=7fced3bc8411add4f4d3c6b70ab4a6f01e30277a;p=redo-blog Update README. --- diff --git a/README.md b/README.md index f16e442..c1d9f4b 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,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. -These files will be linked to symbolically in a directory ./public/. If you -provide or edit a file suffixed .links to basename of an article file, these -links will be added as article-specific linkbacks to the .html file and the feed -entry. +These files will be linked to symbolically in a directory ./public/. + +If you provide or edit a file suffixed .links to basename of an article file, +these links will be added as article-specific linkbacks to the .html file and +the feed entry. + +Just like the .links files, article-specific files containing captcha data are +created and can be edited in ./captchas/. The first line of such a file is meant +as a captcha, and the second line as its description, which may be inserted via +templating into the article HTML file. Some metadata files will also be generated below ./metadata/: For each article, there will be generated a .automatic_metadata (to contain an article's UUID,