summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorAamir Khan <syst3m.w0rm@gmail.com>2012-07-05 01:33:54 -0300
committerAamir Khan <syst3m.w0rm@gmail.com>2012-07-05 01:33:54 -0300
commit97f6e0128c1ccf0eb52788257517ea06f872c0cf (patch)
tree059b80cbe59f4f17c529ed8d70c9d99fd2fd225d /README.rst
parent209345716fe125046a85d5e5a86a0fa6ce00f95f (diff)
downloadhyperkitty-97f6e0128c1ccf0eb52788257517ea06f872c0cf.tar.gz
hyperkitty-97f6e0128c1ccf0eb52788257517ea06f872c0cf.tar.xz
hyperkitty-97f6e0128c1ccf0eb52788257517ea06f872c0cf.zip
Update master
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst30
1 files changed, 18 insertions, 12 deletions
diff --git a/README.rst b/README.rst
index ad8d318..18eb59e 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
+============
+Latest version of Django >= 1.4
+django-social-auth application
+
+
+Installation
+============
+1. Clone the repository
+2. Load some data into postgresql database using 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
-============
-