Update README.

[redo-blog] / README.md

diff --git a/README.md b/README.md
index d9e0f2c0e73618aa0c4cb783eb6f8278f9a82121..c1d9f4b6c751e3d3d92b7864830328fafab0043f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -28,14 +28,23 @@ 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.
+
+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,
 checksum, and creation/modification dates) and a .intermediate file (to contain
 pandoc-formatted article content like title and body); furthermore, files for
 data used in ./feed.xml and ./index.html will, if non-existant, be built there
 and can be edited to customize the blog – namely the files url, author, title,
-index.tmpl, index_snippet.tmpl, article.tmpl. A blog-specific UUID and creation
-date is stored in ./metadata/automatic_metadata
+index.tmpl, index_snippet.tmpl, article.tmpl, linkback.tmpl. A blog-specific
+UUID and creation date is stored in ./metadata/automatic_metadata
 
 recipe to remotely manage a redo blog with git
 ----------------------------------------------
@@ -61,7 +70,7 @@ called `blog`:
       git add metadata/*.automatic_metadata
     fi
     status=\$(git status -s)
-    n_updates=\$(printf "$status" | grep -vE '^\?\?' | wc -l)
+    n_updates=\$(printf "\$status" | grep -vE '^\?\?' | wc -l)
     if [ "\$n_updates" -gt 0 ]; then
       git commit -a -m 'Update metadata'
     fi
@@ -107,5 +116,6 @@ break things.
 The article title is derived in .md files from a first line prefixed with `%`,
 while all other headings are treated as sub-headings. In .rst files, the title
 is derived from a heading that must be at the top of the document, and be of an
-adornment style (such as underlining with `=`) that must be used only once in
-it.
+adornment style (such as underlining with `=`) used only once in it.
+
+Symbolic links in public/ to removed article pages are currently not removed.