+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 docs/build/html directory.
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.