summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAamir Khan <syst3m.w0rm@gmail.com>2012-07-05 00:54:08 -0400
committerAamir Khan <syst3m.w0rm@gmail.com>2012-07-05 00:54:08 -0400
commit160493710538e0f6e805cc78093be477b031a4fb (patch)
tree063f791922a9bbe8bffe4f345fde2446b6214ec7
parent7afba90d9ce6d1c1158042d7d14a8d5e5726b533 (diff)
parent4448105ceaac3eb9ff00f119b40bae3591b20204 (diff)
downloadhyperkitty-160493710538e0f6e805cc78093be477b031a4fb.tar.gz
hyperkitty-160493710538e0f6e805cc78093be477b031a4fb.tar.xz
hyperkitty-160493710538e0f6e805cc78093be477b031a4fb.zip
Merge branch 'master' of https://github.com/syst3mw0rm/hk
-rw-r--r--README.rst30
1 files changed, 18 insertions, 12 deletions
diff --git a/README.rst b/README.rst
index ad8d318..edade50 100644
--- a/README.rst
+++ b/README.rst
@@ -2,10 +2,25 @@
HyperKitty - Archiver for for GNU Mailman v3
===================================
-Copyright (C) 1998-2012 by the Free Software Foundation, Inc.
+HyperKitty is an open source Django application under development. It aims to provide web interface to access GNU Mailman archives.
+
+
+Dependencies
+============
+1. Latest version of Django >= 1.4
+2. django-social-auth application (https://github.com/omab/django-social-auth/)
+
+
+Installation
+============
+1. Clone the repository
+2. Load some data into postgresql database using kittystore (https://github.com/pypingou/kittystore)
-The HyperKitty Django app provides a web interface to
-access GNU Mailman archives.
+
+License
+========
+
+Copyright (C) 1998-2012 by the Free Software Foundation, Inc.
HyperKitty is free software: you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License as
@@ -18,12 +33,3 @@ General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with mailman.client. If not, see <http://www.gnu.org/licenses/>.
-
-
-Requirements
-============
-
-
-Installation
-============
-