Replaced README by README.rst

2 files changed, 29 insertions, 73 deletions

diff --git a/README b/README
deleted file mode 100644
index c5bb9d6..0000000
--- a/README
+++ /dev/null
@@ -1,73 +0,0 @@
-MailMan App
-===========
-
-This application aims at providing an interface to visualize and explore
-mailman archives.
-
-This is a django project.
-
-
-Dependencies:
--------------
-* Django
-* djangorestframework
-* psycopg2 (for postgresql)
-* sqlalchemy (tested with 0.5.5)
-* django-social-auth
-
-To get it run:
---------------
-
-- Aggregate the static content into their rightfull place:
-python manage.py collectstatic
-
-- Sync the database
-python manage.py syncdb
-
-- Start the server:
-python manage.py runserver
-
-
-To get it running under virtualenv:
------------------------------------
-# Create the virtualenv
-virtualenv mailman3
-# Activate the virtualenv
-cd mailman3
-source bin/activate
-
-# Install django and dependencies
-easy_install django
-easy_install sqlalchemy
-easy_install psycopg2
-easy_install django-social-auth
-easy_install djangorestframework
-easy_install django-gravatar
-
-# Install postgresql
-sudo yum install postgresql
-# Start the database
-sudo service postgresql start
-# Configure your database as you wish
-
-# retrieve the sources there:
-bzr branch bzr://bzr.fedorahosted.org/bzr/hyperkitty/gsoc
-
-# Start it
-cd gsoc
-# Retrieve the sources from kittystore
-git clone https://github.com/pypingou/kittystore.git
-# clean them
-cd kittystore
-rm ./*
-mv kittystore/* .
-rmdir kittystore
-
-# You will want to configure the access to the database in the settings.py file
-# Adjust the variable: KITTYSTORE_URL
-vim settings.py
-
-## Run the server
-cd ..
-python manage.py runserver
-
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..ad8d318
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,29 @@
+===================================
+HyperKitty - Archiver for for GNU Mailman v3
+===================================
+
+Copyright (C) 1998-2012 by the Free Software Foundation, Inc.
+
+The HyperKitty Django app provides a web interface to
+access GNU Mailman archives.
+
+HyperKitty is free software: you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation, version 3 of the License.
+
+HyperKitty is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
+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
+============
+