Mercurial > hg > chronicle
annotate README @ 82:249ca4872b6c
Updated version number
author | Steve Kemp <steve@steve.org.uk> |
---|---|
date | Tue, 11 Dec 2007 10:56:27 +0000 |
parents | e5b192246b68 |
children | 10797bf26799 |
rev | line source |
---|---|
1 | 1 |
19 | 2 Homepage: |
3 http://www.steve.org.uk/Software/chronicle/ | |
4 | |
65
88f87687b36e
Removed references to the CVS repository and replaced them with Mercurial.
Steve Kemp <steve@steve.org.uk>
parents:
19
diff
changeset
|
5 Mercurial Repository: |
88f87687b36e
Removed references to the CVS repository and replaced them with Mercurial.
Steve Kemp <steve@steve.org.uk>
parents:
19
diff
changeset
|
6 http://chronicle.repository.steve.org.uk/ |
19 | 7 |
69 | 8 Sample Output: |
9 http://www.steve.org.uk/Software/chronicle/demo/ | |
19 | 10 |
11 | |
12 | |
1 | 13 chronicle - A blog compiler |
14 --------------------------- | |
15 | |
19 | 16 Chronicle is a tool which will convert a directory of simple |
17 text files into a static HTML weblog, (or blog if you prefer). | |
18 | |
19 The system is intentionally simple, but it does support: | |
20 | |
21 * Template based output. | |
1 | 22 |
19 | 23 * Support for RSS feeds. |
24 | |
25 * Support for tagged entries. | |
26 | |
27 | |
28 | |
1 | 29 |
30 | |
31 Installation | |
32 ------------ | |
33 | |
19 | 34 It is possible to run the software without installing it, just |
35 by placing blog entries in the ./blog directory and running | |
36 ./bin/chronicle. | |
37 | |
38 However it is recommended you install the software system-wide | |
39 by running "make install" as root. | |
40 | |
41 This will give you: | |
1 | 42 |
19 | 43 /usr/share/chronicle <- The theme directories. |
44 /usr/local/bin/chronicle <- The main binary. | |
45 /etc/chroniclerc <- The main configuration file. | |
46 | |
47 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 will prevent changes from being overwritten on upgrade. | |
50 | |
51 The configuration file may be copied to ~/.chroniclerc for | |
52 per-user configuration. | |
1 | 53 |
54 | |
55 | |
56 Blog Format | |
57 ----------- | |
58 | |
59 The blog format is very simple. Each file should start like this: | |
60 | |
19 | 61 /-- |
1 | 62 title: The title of my post |
63 date: 12 August 2007 | |
64 tags: foo, bar, baz | |
19 | 65 |
66 The text of the actual entry goes here. | |
67 | |
68 However much there is of it. | |
69 \-- | |
70 | |
1 | 71 |
72 The tags are optional, but recommended, similarly the date of the post | |
19 | 73 is used in preference to the current date if none is present. |
1 | 74 |
75 | |
19 | 76 Bugs? |
77 ----- | |
1 | 78 |
19 | 79 Please report bugs to the author, where they will be fixed as |
80 quickly as possible. | |
1 | 81 |
82 | |
83 Steve | |
84 -- |