================================================================
Croquant - set of MoinMoin plugins for integration with Crunchy
================================================================

Croquant aims to facilitate writing Crunchy python tutorials using the 
MoinMoin wiki server.  It has been tested with the desktop
edition of MoinMoin 1.7.0.

Installation
============

The tedious way to install Croquant is simply to copy all files

from                        to
-----------------------------------------
parser/                     YOUR_WIKI/data/plugin/parser/
macro/                      YOUR_WIKI/data/plugin/macro/
theme/crunchy               YOUR_WIKI/htdocs/crunchy/
theme/crunchy.py            YOUR_WIKI/data/plugin/theme/

You can also do the same automatically using install.py as follows:
$ python install.py YOUR_WIKI

where YOUR_WIKI could be something like full/path/moin-1.7.0/wiki/

With parsers and macros, a Crunchy theme is installed. If you want to use it
as the default, a configuration file is provided in
config-sample/wikiconfig.py.
If you use MoinMoin 1.7.0 Desktop Edition, you can copy this file in
moin-1.7.0/wikiconfig_local.py

You can also use the configuration file config_sample/wikiconfig_python.py to
make the theme behave similarly to the one of wiki.python.org by copying it to 
moin-1.7.0/wikiconfig_local.py

File name confusions
====================

Please note there are a few files named "crunchy.py". They are not the same
file at all! If you plan to setup a wiki using Croquant, you must be careful
about the role of each:

 * parser/crunchy.py is the parser used when you write a block of python code
   with VLAM instructions for Crunchy, inside a MoinMoin page.
 * theme/crunchy.py is a part of the crunchy theme for MoinMoin
 
There is also a file named crunchy.py in the Crunchy application, which is
used to start Crunchy itself.

See also
========
 * Python: <http://python.org/>
 * Crunchy: <http://code.google.com/p/crunchy/>
 * MoinMoin: <http://moinmo.in/>
 * Croquant: <http://code.google.com/p/croquant/>

Copyright
=========

Copyright (c) 2008 Florian Birée <florian.biree@gmail.com>

All rights reserved, see LICENSE for details.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA