Mercurial > hg > chronicle
comparison README @ 1:bc8961a81af6 release
2007-08-13 22:53:14 by steve
Initial revision
author | steve |
---|---|
date | Mon, 13 Aug 2007 22:53:14 +0000 |
parents | |
children | 8af29bfa35b0 |
comparison
equal
deleted
inserted
replaced
0:30c6796bded8 | 1:bc8961a81af6 |
---|---|
1 | |
2 chronicle - A blog compiler | |
3 --------------------------- | |
4 | |
5 Chronicle is a tool which will convert a directory of text files | |
6 into a static HTML weblog, or blog. | |
7 | |
8 The system supports tagged entries, and several other useful features, | |
9 but it is primarily designed to be as simple to possible to install | |
10 and use. | |
11 | |
12 | |
13 Installation | |
14 ------------ | |
15 | |
16 No installation is currently required; simply create your blog entries | |
17 in the data/ directory and run "./bin/chronicle" to create HTML files | |
18 in the output/ directory. | |
19 | |
20 Each output page will be re-created from scratch at this point, so | |
21 if you've edited any of your files they will be regenerated to include | |
22 your updated text. | |
23 | |
24 | |
25 | |
26 Blog Format | |
27 ----------- | |
28 | |
29 The blog format is very simple. Each file should start like this: | |
30 | |
31 -- | |
32 title: The title of my post | |
33 date: 12 August 2007 | |
34 tags: foo, bar, baz | |
35 ... | |
36 ... | |
37 ... | |
38 -- | |
39 | |
40 The tags are optional, but recommended, similarly the date of the post | |
41 is used in preference to the current date. | |
42 | |
43 | |
44 Customisation | |
45 ------------- | |
46 | |
47 Templates are used to create the output, and you will find those | |
48 located within the ./etc/ directory. | |
49 | |
50 | |
51 Steve | |
52 -- |