git » wikiri » master » tree

[master] / README

wikiri - A single-file wiki engine
==================================

wikiri is a single-file blog engine, written in Python_ and using
reStructuredText_ for markup.

It's licenced under the BOLA_ license, which is pretty much the same as public
domain. Read the *LICENSE* file for more information.


Installing wikiri
-----------------

First of all, you need a webserver. Put ``wikiri.cgi`` in a directory where
CGI is allowed.

Then, create a data directory, where you will store your articles.

Finally, configure wikiri by either copying the ``config.py.sample`` as
``config.py`` to the same directory where you put ``wikiri.cgi``, or editing
the values inside ``wikiri.cgi``. The former is recommended to simplify
updates.

You can now browse the page to get to the index page.


Personalizing templates
-----------------------

If you don't like the default look, you can write your own templates for
wikiri. This needs to be properly documented, but it's very obvious when you
look at the code.


Complaints and suggestions
--------------------------

If you have any questions, suggestions or comments, please send them to me,
Alberto Bertogli, at albertito@blitiri.com.ar.


.. _Python: http://www.python.org/
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _BOLA: http://blitiri.com.ar/p/bola/