X-Git-Url: https://plomlompom.com/repos/?p=redo-blog;a=blobdiff_plain;f=README.md;h=c28df86a0a0488f6b33bf9545a9de78718f318c9;hp=e4d63fa5f6c218e056a13cf37c634181b37a3400;hb=a8f1293b7fdf45388f990afabe194ad3d09502b4;hpb=1c7b84260b8a71cabce924814a1d36ed6567a67e

diff --git a/README.md b/README.md
index e4d63fa..c28df86 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
 redo-blog
 =========
 
-small blog system using the redo build system
+small blog system using the redo build system, with blog article files written
+in (pandoc) Markdown or ReStructured Text.
 
 dependencies
 ------------
@@ -29,12 +30,12 @@ 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.
+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.
 
-recipe to use server-side with git
-----------------------------------
+recipe to remotely manage a redo blog with git
+----------------------------------------------
 
 On your server, install the dependencies listed above. Then set up a repository
 for your blog files. Let's assume we want it to sit in our home directory and be
@@ -46,7 +47,7 @@ called `blog`:
     cat << EOF > blog.git/hooks/post-update
     #!/bin/sh
     BLOGDIR=~/blog
-    GIT_WORK_TREE=$BLOGDIR git checkout -f
+    GIT_WORK_TREE=\$BLOGDIR git checkout -f
     cd \$BLOGDIR
     redo
     EOF
@@ -64,7 +65,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
@@ -76,11 +78,14 @@ Client-side, do this (obviously, replace server and username):
     git commit -m 'set up blog metadata'
     git push origin master
 
-bugs
-----
+bugs and peculiarities
+----------------------
 
 Don't create a index.rst or index.md in the redo-managed directory, that will
 break things.
 
-Running redo without a single blog entry source file (.md or .rst) in the
-directory will also 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.