Mercurial > hg > chronicle
diff COMMENTS @ 109:10797bf26799
Added 'COMMENTS' to the file.
author | Steve Kemp <steve@steve.org.uk> |
---|---|
date | Thu, 13 Dec 2007 12:18:20 +0000 |
parents | |
children | b296489d9ea1 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/COMMENTS Thu Dec 13 12:18:20 2007 +0000 @@ -0,0 +1,46 @@ + + + Chronicle, since version 2.0, supports the submission of post + comments. + + The way this works is rather non-standard so please read this + document to understand it. + + +Basic Usage +----------- + + The basic use of chronicle is to convert a collection of text files + into a HTML & RSS blog. + + Generally it appears that people will do this upon a local machine, + then scp, rsync, or otherwise move the output into place upon their + remote webserver. + + This process looks something like this: + + chronicle --input=./blog --output=./html + rsync html user@host:/path/to/blog + + +Advanced Usage +-------------- + + Since the blog, once produced, is typically stored upon a remote + system there is no easy way for comments which are stored upon that + system to be integrated into the main blog. + + The solution to this problem is to merely record comments upon + the webserver in simple text files. + + Later these can be fetched to the machine which is building the + blog, and integrated for the next rebuild: + + + scp uesr@host://path/to/comments/* ./comments/ + chronicle --input=./blog --output=./html --comments=./comments + rsync html user@host:/path/to/blog + + +Steve +-- \ No newline at end of file