Clever Harold README
====================

:Authors:
  Troy Melhase <troy@gci.net>

:Updated:
  21 June 2006

:Version:
  0.1

:License:
  GPL

:Homepage:
  http://www.cleverharold.org/


Description
-----------
Clever Harold is an experimental web framework.


Getting Help and Getting Involved
---------------------------------
If you have questions or problems, first search the `Trac wiki`_.
Finding no solution there, post a message to the `mailing list`_.
You're always welcome to `email me directly`_, and I'll do my best to
help you.

Harold needs feedback, improvement, and a lot more development; I
invite you to participate at any and levels.  Drop me a note if you'd
like repository or wiki write privileges.

.. _Trac wiki:  http://trac.cleverharold.org/
.. _mailing list:  http://groups.google.com/group/cleverharold
.. _email me directly: troy@gci.net


Documentation
-------------
User documentation, tutorials, and API references are also kept in the
Trac wiki.  Refer to the `Documentation Index`_ for a complete list.

.. _Documentation Index: http://trac.cleverharold.org/wiki/DocumentationIndex


Install
-------
Thanks to setuptools_, installing Clever Harold is deviously simple:

::

  $ easy_install cleverharold

You can also download and install manually.  The digest version goes
something like this:

:: 

  $ wget http://cheeseshop.python.org/packages/source/C/CleverHarold/CleverHarold-0.1.tar.gz
  $ tar xfz CleverHarold-0.1.tar.gz
  $ cd CleverHarold
  $ python setup.py install

.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools


Dependencies
------------
Harold cleverly reuses some of the greatest software available.  If
you're installing manually, you'll have to satisfy these dependencies
before using Harold in your projects:

- `Kid 0.9.2`_
- `Paste 0.9.3`_
- `PasteScript 0.9`_
- `simplejson 1.3`_

.. _Kid 0.9.2: http://cheeseshop.python.org/pypi/kid/0.9.2
.. _Paste 0.9.3: http://cheeseshop.python.org/pypi/Paste/0.9.3
.. _PasteScript 0.9:  http://cheeseshop.python.org/pypi/PasteScript/0.9
.. _simplejson 1.3:  http://cheeseshop.python.org/pypi/simplejson


Known Bugs and Issues
---------------------

Bugs and other issues are tracked via the Trac `ticket system`_.  The
summary report of `all active tickets`_ is a good starting point.

.. _ticket system:  http://trac.cleverharold.org/report
.. _all active tickets:  http://trac.cleverharold.org/report/1
