README

   1
   2 wikiri - A single-file wiki engine
   3 ==================================
   4
   5 wikiri is a single-file blog engine, written in Python_ and using
   6 reStructuredText_ for markup.
   7
   8 It's licenced under the BOLA_ license, which is pretty much the same as public
   9 domain. Read the *LICENSE* file for more information.
  10
  11
  12 Installing wikiri
  13 -----------------
  14
  15 First of all, you need a webserver. Put ``wikiri.cgi`` in a directory where
  16 CGI is allowed.
  17
  18 Then, create a data directory, where you will store your articles.
  19
  20 Finally, configure wikiri by either copying the ``config.py.sample`` as
  21 ``config.py`` to the same directory where you put ``wikiri.cgi``, or editing
  22 the values inside ``wikiri.cgi``. The former is recommended to simplify
  23 updates.
  24
  25 You can now browse the page to get to the index page.
  26
  27
  28 Personalizing templates
  29 -----------------------
  30
  31 If you don't like the default look, you can write your own templates for
  32 wikiri. This needs to be properly documented, but it's very obvious when you
  33 look at the code.
  34
  35
  36 Complaints and suggestions
  37 --------------------------
  38
  39 If you have any questions, suggestions or comments, please send them to me,
  40 Alberto Bertogli, at albertito@blitiri.com.ar.
  41
  42
  43 .. _Python: http://www.python.org/
  44 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
  45 .. _BOLA: http://blitiri.com.ar/p/bola/
  46