Mercurial > hg > chronicle

comparison README @ 19:8af29bfa35b0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
2007-08-14 21:13:09 by steve Updated.
author steve
date Tue, 14 Aug 2007 21:13:09 +0000
parents bc8961a81af6
children 88f87687b36e
comparison
equal deleted inserted replaced
18:c1e8ae6c878d 19:8af29bfa35b0
1 1
2 Homepage:
3 http://www.steve.org.uk/Software/chronicle/
4
5 CVS Repository:
6 http://chronicle.cvsrepository.org/
7
8
9
10
2 chronicle - A blog compiler 11 chronicle - A blog compiler
3 --------------------------- 12 ---------------------------
4 13
5 Chronicle is a tool which will convert a directory of text files 14 Chronicle is a tool which will convert a directory of simple
6 into a static HTML weblog, or blog. 15 text files into a static HTML weblog, (or blog if you prefer).
7 16
8 The system supports tagged entries, and several other useful features, 17 The system is intentionally simple, but it does support:
9 but it is primarily designed to be as simple to possible to install 18
10 and use. 19 * Template based output.
20
21 * Support for RSS feeds.
22
23 * Support for tagged entries.
24
25
26
11 27
12 28
13 Installation 29 Installation
14 ------------ 30 ------------
15 31
16 No installation is currently required; simply create your blog entries 32 It is possible to run the software without installing it, just
17 in the data/ directory and run "./bin/chronicle" to create HTML files 33 by placing blog entries in the ./blog directory and running
18 in the output/ directory. 34 ./bin/chronicle.
19 35
20 Each output page will be re-created from scratch at this point, so 36 However it is recommended you install the software system-wide
21 if you've edited any of your files they will be regenerated to include 37 by running "make install" as root.
22 your updated text. 38
39 This will give you:
40
41 /usr/share/chronicle <- The theme directories.
42 /usr/local/bin/chronicle <- The main binary.
43 /etc/chroniclerc <- The main configuration file.
44
45 If you wish to customise the templates it is recommended you
46 make a copy of them with a new name, then edit that copy. This
47 will prevent changes from being overwritten on upgrade.
48
49 The configuration file may be copied to ~/.chroniclerc for
50 per-user configuration.
23 51
24 52
25 53
26 Blog Format 54 Blog Format
27 ----------- 55 -----------
28 56
29 The blog format is very simple. Each file should start like this: 57 The blog format is very simple. Each file should start like this:
30 58
31 -- 59 /--
32 title: The title of my post 60 title: The title of my post
33 date: 12 August 2007 61 date: 12 August 2007
34 tags: foo, bar, baz 62 tags: foo, bar, baz
35 ... 63
36 ... 64 The text of the actual entry goes here.
37 ... 65
38 -- 66 However much there is of it.
67 \--
68
39 69
40 The tags are optional, but recommended, similarly the date of the post 70 The tags are optional, but recommended, similarly the date of the post
41 is used in preference to the current date. 71 is used in preference to the current date if none is present.
42 72
43 73
44 Customisation 74 Bugs?
45 ------------- 75 -----
46 76
47 Templates are used to create the output, and you will find those 77 Please report bugs to the author, where they will be fixed as
48 located within the ./etc/ directory. 78 quickly as possible.
49 79
50 80
51 Steve 81 Steve
52 -- 82 --