============================================
HyperKitty - Archiver for for GNU Mailman v3
============================================

HyperKitty is an open source Django application under development. It aims at
providing a web interface to access GNU Mailman archives.

The code is available from: https://github.com/hyperkitty/hyperkitty

The documentation is located in the "doc" subfolder. It can be generated in
various formats thanks to `Sphinx`_. To generate the HTML documentation, run
the following command::

    make -C doc html

The HTML files will be available in the ``doc/_build/html`` directory.

The documentation can also be browsed online at:
https://hyperkitty.readthedocs.org.

.. _Sphinx: http://sphinx-doc.org


License
=======

HyperKitty is licensed under the `GPL v3.0`_

.. _GPL v3.0: http://www.gnu.org/licenses/gpl-3.0.html