summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorAurélien Bompard <aurelien@bompard.org>2012-11-21 17:32:37 +0100
committerAurélien Bompard <aurelien@bompard.org>2012-11-21 17:32:37 +0100
commit527086586d7752243f7574a1e2f395e996d4ecf9 (patch)
treeec4cc226ba79a1aa99b683939208c02f32537750 /README.rst
parent179dd8ac917b04e9dcc6d978fe0464f66adafb72 (diff)
downloadhyperkitty-527086586d7752243f7574a1e2f395e996d4ecf9.tar.gz
hyperkitty-527086586d7752243f7574a1e2f395e996d4ecf9.tar.xz
hyperkitty-527086586d7752243f7574a1e2f395e996d4ecf9.zip
Prepare for release
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst48
1 files changed, 14 insertions, 34 deletions
diff --git a/README.rst b/README.rst
index bb6c0b4..91032b2 100644
--- a/README.rst
+++ b/README.rst
@@ -1,46 +1,26 @@
-===================================
+============================================
HyperKitty - Archiver for for GNU Mailman v3
-===================================
+============================================
-HyperKitty is an open source Django application under development. It aims to provide web interface to access GNU Mailman archives.
+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: http://bzr.fedorahosted.org/bzr/hyperkitty/
-Installation
-============
+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::
-1. git clone https://github.com/syst3mw0rm/hyperkitty
-2. cd hyperkitty
-3. python setup.py develop
-4. Clone KittyStore and Load archive data into postgresql using kittystore (https://github.com/pypingou/kittystore)
-5. Create symlink kittystore using **ln -s {path-to-kittystore}/kittystore/ kittystore**
-6. Install hk-app (https://github.com/syst3mw0rm/hk-app)
+ make -C doc html
-Dependencies
-============
+The HTML files will be available in the ``doc/_build/html`` directory.
-Hyperkitty dependencies
------------------------
-* Django==1.4
-* URLObject==2.0.2
-* django-gravatar==0.1.0
-* django-social-auth==0.7.0
-* djangorestframework==0.3.3
-* httplib2==0.7.4
-* oauth2==1.5.211
-* psycopg2==2.4.5
-* python-openid==2.2.5
-* wsgiref==0.1.2
+.. _Sphinx: http://sphinx-doc.org
-kittystore dependencies
------------------------
-* SQLAlchemy==0.7.8
+License
+=======
-
-
-License
-========
+HyperKitty is licensed under the `GPL v3.0`_
.. _GPL v3.0: http://www.gnu.org/licenses/gpl-3.0.html
-
-HyperKitty is licensed under the `GPL v3.0`_