X-Git-Url: https://code.grnet.gr/git/pithos/blobdiff_plain/f2d7b5abd25f8b616483a01e5f2182b1ef691dc4..690747fe1b602c9ac0abd2e2b337dbaa8a61eb48:/README

diff --git a/README b/README
index 9541ad2..4193cc8 100644
--- a/README
+++ b/README
@@ -1,23 +1,46 @@
+README
+======
+
+Pithos is a file storage service, built by GRNET using Django (https://www.djangoproject.com/).
+Learn more about Pithos at: http://code.grnet.gr/projects/pithos
+Consult LICENSE for licensing information.
+
 Documentation
 -------------
 
-To build the documentation you need to have Sphinx installed:
-http://sphinx.pocoo.org/
+All docs are in the docs/source directory. The .rst files are perfectly readable in source form.
+
+To build the documentation you need to have Sphinx (http://sphinx.pocoo.org/) installed.
 
-Run:
+On a typical debian-based Linux system run:
+    apt-get install python-django python-django-south python-setuptools python-sphinx python-httplib2
+    apt-get install python-sqlalchemy python-mysqldb python-psycopg2
+
+Then run:
     python setup.py build_sphinx
 
-The documentation will be built in the doc/build/html directory.
+The documentation will be built in the docs/build/html directory.
 
 Also run:
     python setup.py build_sphinx -b text
 
-Then find the plain text version of the docs in doc/build/text.
+Then find the plain text version of the docs in docs/build/text.
 
 Running the server
 ------------------
 
-Enter the pithos dir and run:
+Make sure you have all required packages installed:
+    apt-get install python-django python-setuptools python-sphinx python-httplib2
+    apt-get install python-sqlalchemy python-mysqldb python-psycopg2
+
+Then run:
+    python manage.py syncdb
+    python manage.py schemamigration im --initial
+    python manage.py loaddata admin_user
     python manage.py runserver
 
+Go to:
+	http://127.0.0.1:8000/im/admin?user=admin&token=0000
+
 This server is useful during development, but should not be used for deployment.
+To deploy Pithos using Apache, take a look at the Administrator Guide in docs.