Homepage:
    http://www.steve.org.uk/Software/chronicle/

Mercurial Repository:
    http://chronicle.repository.steve.org.uk/



         
chronicle - A blog compiler
---------------------------

  Chronicle is a tool which will convert a directory of simple
 text files into a static HTML weblog, (or blog if you prefer).

  The system is intentionally simple, but it does support:

  * Template based output.

  * Support for RSS feeds.

  * Support for tagged entries.





Installation
------------

  It is possible to run the software without installing it, just 
 by placing blog entries in the ./blog directory and running
 ./bin/chronicle.

  However it is recommended you install the software system-wide
 by running "make install" as root.

  This will give you:

    /usr/share/chronicle        <-  The theme directories.
    /usr/local/bin/chronicle    <-  The main binary.
    /etc/chroniclerc            <-  The main configuration file.

  If you wish to customise the templates it is recommended you
 make a copy of them with a new name, then edit that copy.  This
 will prevent changes from being overwritten on upgrade.

  The configuration file may be copied to ~/.chroniclerc for
 per-user configuration.



Blog Format
-----------

  The blog format is very simple.  Each file should start like this:

  /--
   title:  The title of my post
   date: 12 August 2007
   tags: foo, bar, baz

   The text of the actual entry goes here.

   However much there is of it.
  \--


  The tags are optional, but recommended, similarly the date of the post
 is used in preference to the current date if none is present.


Bugs?
-----

  Please report bugs to the author, where they will be fixed as
 quickly as possible.


Steve
--