home · contact · privacy
Re-write date handling, remove dependency on filesystem lastmod dates.
[redo-blog] / README.md
index a0071b3473e19ed7f2b6dd54fac3971a7074f7ca..822c08d594be5e0cc29b3e07acc2a3cdba68a2c4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -29,10 +29,13 @@ You can then enter the directory and run redo there. This will generate article
 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
+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, uuid,
-title, index.tmpl, index_snippet.tmpl, article.tmpl.
+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
 
 recipe to remotely manage a redo blog with git
 ----------------------------------------------
@@ -65,7 +68,8 @@ public web content to sit:
 
     ln -s ~/blog/public /var/www/html/blog
 
-Client-side, do this (obviously, replace server and username):
+Client-side, do this (you obviously need to customize this code; at least
+replace the username `user` and the server name `example.org`):
 
     cd ~
     git init blog
@@ -83,8 +87,8 @@ bugs and peculiarities
 Don't create a index.rst or index.md in the redo-managed directory, that will
 break things.
 
-The article title is derived in .md files from a first line prefixed with "% ",
+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
+adornment style (such as underlining with `=`) that must be used only once in
 it.