Mercurial > hg > chronicle

comparison README @ 109:10797bf26799

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added 'COMMENTS' to the file.
author Steve Kemp <steve@steve.org.uk>
date Thu, 13 Dec 2007 12:18:20 +0000
parents e5b192246b68
children df0201e39fed
comparison
equal deleted inserted replaced
108:a25099606ec5 109:10797bf26799
6 http://chronicle.repository.steve.org.uk/ 6 http://chronicle.repository.steve.org.uk/
7 7
8 Sample Output: 8 Sample Output:
9 http://www.steve.org.uk/Software/chronicle/demo/ 9 http://www.steve.org.uk/Software/chronicle/demo/
10 10
11 Real World Use:
12 http://blog.steve.org.uk/
11 13
12 14
15
13 chronicle - A blog compiler 16 chronicle - A blog compiler
14 --------------------------- 17 ---------------------------
15 18
16 Chronicle is a tool which will convert a directory of simple 19 Chronicle is a tool which will convert a directory of simple
17 text files into a static HTML weblog, (or blog if you prefer). 20 text files into a static HTML weblog, (or blog if you prefer).
18 21
19 The system is intentionally simple, but it does support: 22 The system is intentionally simple, but it does support:
20 23
21 * Template based output. 24 * Template based output.
22
23 * Support for RSS feeds. 25 * Support for RSS feeds.
24
25 * Support for tagged entries. 26 * Support for tagged entries.
26 27 * Optional support for comments.
27 28
28 29
29 30
30 31
31 Installation 32 Installation
39 by running "make install" as root. 40 by running "make install" as root.
40 41
41 This will give you: 42 This will give you:
42 43
43 /usr/share/chronicle <- The theme directories. 44 /usr/share/chronicle <- The theme directories.
44 /usr/local/bin/chronicle <- The main binary. 45 /usr/bin/chronicle <- The main binary.
45 /etc/chroniclerc <- The main configuration file. 46 /etc/chroniclerc <- The main configuration file.
46 47
47 If you wish to customise the templates it is recommended you 48 If you wish to customise the templates it is recommended you
48 make a copy of them with a new name, then edit that copy. This 49 make a copy of them with a new name, then edit that copy. This
49 will prevent changes from being overwritten on upgrade. 50 will prevent changes from being overwritten on upgrade.
71 72
72 The tags are optional, but recommended, similarly the date of the post 73 The tags are optional, but recommended, similarly the date of the post
73 is used in preference to the current date if none is present. 74 is used in preference to the current date if none is present.
74 75
75 76
77
78 Comment Support
79 ---------------
80
81 The system supports the submission of user-supplied comments upon
82 posts, for more details please see the included file COMMENTS.
83
84
85
76 Bugs? 86 Bugs?
77 ----- 87 -----
78 88
79 Please report bugs to the author, where they will be fixed as 89 Please report bugs to the author, where they will be fixed as
80 quickly as possible. 90 quickly as possible.