Warning, /grantlee/README.md is written in an unsupported language. File is not indexed.

0001 
0002 The Grantlee Libraries
0003 ======================
0004 
0005 [![OSX/Linux Build Status](https://travis-ci.org/steveire/grantlee.svg?branch=master)](https://travis-ci.org/steveire/grantlee)
0006 [![Windows Build status](https://ci.appveyor.com/api/projects/status/github/steveire/grantlee?branch=master&svg=true)](https://ci.appveyor.com/project/steveire/grantlee/branch/master)
0007 
0008 * About Grantlee
0009 * Installation
0010 * Licensing
0011 * Contributing
0012 
0013 About Grantlee
0014 --------------
0015 
0016 Grantlee is a set of Free Software libraries written using the [Qt framework](http://code.qt.io).
0017 Currently two libraries are shipped with Grantlee: Grantlee Templates and Grantlee
0018 TextDocument.
0019 
0020 The goal of Grantlee Templates is to make it easier for application developers to
0021 separate the structure of documents from the data they contain, opening the door
0022 for theming and advanced generation of other text such as code.
0023 
0024 The syntax uses the syntax of the [Django template system](https://docs.djangoproject.com/en/1.9/ref/templates/language/), and
0025 the core design of Django is reused in Grantlee.
0026 
0027     <ul>
0028     {% for athlete in athlete_list %}
0029     <li>{{ athlete.name }}{% if athlete.isCaptain %} (C){% endif %}</li>
0030     {% endfor %}
0031     </ul>
0032 
0033 Part of the design of both template systems is that application developers can
0034 extend the syntax by implementing their own tags and filters. For details of how
0035 to do that, see the [API documentation](http://www.grantlee.org/apidox/extension.html).
0036 
0037 Installation
0038 ------------
0039 
0040 To build Grantlee, you need at least Qt5.3 (with development packages) and CMake 3.1.
0041 Out-of-source builds are recommended:
0042 
0043     mkdir build
0044     cd build
0045     cmake -DCMAKE_INSTALL_PREFIX=$prefix ..
0046     cmake --build .
0047     cmake --build . --target install
0048 
0049 Licensing
0050 ---------
0051 
0052 Grantlee is covered by the GNU Lesser General Public License Version 2.1, or
0053 at your option, any later version. All contributions to Grantlee must be
0054 covered by the same license.
0055 
0056 The details of the license are in the COPYING file in the source distribution.
0057 
0058 Contributing
0059 ------------
0060 
0061 Grantlee is hosted on github, and welcomes pull requests and issues.
0062