Mercurial > hg > chronicle

annotate README @ 148:f4f02112a523

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated Debian files
author Steve Kemp <steve@steve.org.uk>
date Fri, 28 Dec 2007 14:32:12 +0000
parents 10797bf26799
children df0201e39fed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
1
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
2 Homepage:
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
3 http://www.steve.org.uk/Software/chronicle/
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
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
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
7
69
e5b192246b68 Mention the demo site.
Steve Kemp <steve@steve.org.uk>
parents: 65
diff changeset
8 Sample Output:
e5b192246b68 Mention the demo site.
Steve Kemp <steve@steve.org.uk>
parents: 65
diff changeset
9 http://www.steve.org.uk/Software/chronicle/demo/
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
10
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
11 Real World Use:
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
12 http://blog.steve.org.uk/
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
13
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
14
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
15
1
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
16 chronicle - A blog compiler
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
17 ---------------------------
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
18
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
19 Chronicle is a tool which will convert a directory of simple
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
20 text files into a static HTML weblog, (or blog if you prefer).
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
21
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
22 The system is intentionally simple, but it does support:
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
23
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
24 * Template based output.
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
25 * Support for RSS feeds.
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
26 * Support for tagged entries.
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
27 * Optional support for comments.
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
28
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
29
1
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
30
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
31
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
32 Installation
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
33 ------------
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
34
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
35 It is possible to run the software without installing it, just
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
36 by placing blog entries in the ./blog directory and running
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
37 ./bin/chronicle.
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
38
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
39 However it is recommended you install the software system-wide
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
40 by running "make install" as root.
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
41
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
42 This will give you:
1
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
43
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
44 /usr/share/chronicle <- The theme directories.
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
45 /usr/bin/chronicle <- The main binary.
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
46 /etc/chroniclerc <- The main configuration file.
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
47
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
48 If you wish to customise the templates it is recommended you
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
49 make a copy of them with a new name, then edit that copy. This
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
50 will prevent changes from being overwritten on upgrade.
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
51
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
52 The configuration file may be copied to ~/.chroniclerc for
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
53 per-user configuration.
1
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
54
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
55
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
56
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
57 Blog Format
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
58 -----------
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
59
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
60 The blog format is very simple. Each file should start like this:
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
61
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
62 /--
1
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
63 title: The title of my post
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
64 date: 12 August 2007
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
65 tags: foo, bar, baz
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
66
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
67 The text of the actual entry goes here.
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
68
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
69 However much there is of it.
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
70 \--
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
71
1
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
72
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
73 The tags are optional, but recommended, similarly the date of the post
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
74 is used in preference to the current date if none is present.
1
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
75
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
76
109
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
77
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
78 Comment Support
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
79 ---------------
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
80
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
81 The system supports the submission of user-supplied comments upon
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
82 posts, for more details please see the included file COMMENTS.
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
83
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
84
10797bf26799 Added 'COMMENTS' to the file.
Steve Kemp <steve@steve.org.uk>
parents: 69
diff changeset
85
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
86 Bugs?
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
87 -----
1
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
88
19
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
89 Please report bugs to the author, where they will be fixed as
8af29bfa35b0 2007-08-14 21:13:09 by steve
steve
parents: 1
diff changeset
90 quickly as possible.
1
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
91
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
92
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
93 Steve
bc8961a81af6 2007-08-13 22:53:14 by steve
steve
parents:
diff changeset
94 --