
The Grantlee Template System
============================
Version 0.1

* About Grantlee
* Installation
* Licensing
* Contributing

About Grantlee
--------------

Grantlee is a plugin based String Template system written using the Qt framework.
The goals of the project are to make it easier for application developers to
separate the structure of documents from the data they contain, opening the door
for theming.

The syntax is intended to follow the syntax of the Django template system, and
the design of Django is reused in Grantlee. Django is covered by a BSD style license.

Part of the design of both is that application developers can extend the syntax by
implementing their own tags and filters. For details of how to do that, see the API
documentation.

For template authors, different applications using Grantlee will present the same
interface and core syntax for creating new themes. For details of how to write
templates, see the documentation.

The Grantlee distribution contains several components.

* corelib contains the code for parsing and interpreting template
    syntax, as well as interfaces for extending the syntax using plugins.
* gui contains some classes for creating textual output from QTextDocuments.
* examples contains some small applications demonstrating how Grantlee can be used.
* loadertags contains the library of tags used to perform template
    inclusion, and inheritance.
* defaulttags contains the library of tags made available by default to
    all templates. These tags include for example 'for', 'if', 'ifequal' etc.
* defaultfilters contains the library of filters made available by default
    to all templates. These filters include for example 'upper', 'lower', 'cut' etc.
* scriptabletags contains a plugin library implementation using QtScript to 
    implement plugins.
* tests contains the unit tests for Grantlee.
* scripts contains convenience scripts for creating release tarballs, generating #
    documentation, creating translation files etc.

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

To build Grantlee, you need at least Qt4.5 (with development packages) and CMake 2.6.
Out-of-source builds are recommended:

mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=$prefix ..
make && make install

Licensing
---------

Grantlee is covered by the GNU Lesser General Public License Version 2.1, or
at your option, any later version. All contributions to Grantlee must be
covered by the same license.

The details of the license are in the COPYING file in the source distribution.

Contributing
------------

Grantlee is hosted on a git repository at http://gitorious.org/grantlee.

To get started, clone the repository,

  git clone git://gitorious.org/grantlee/grantlee.git

and build it as above. Create a merge request for your changes to be pulled into
the main repository.

