Fix docs.

[pithos] / README

diff --git a/README b/README
index f005aee..ddee9dd 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,8 @@
 README
 ======
 
-Pithos is a file storage service, built using Django (https://www.djangoproject.com/).
+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
@@ -13,9 +14,7 @@ To build the documentation you need to have Sphinx (http://sphinx.pocoo.org/) in
 
 On a typical debian-based Linux system run:
     apt-get install python-django python-setuptools python-sphinx
-    apt-get install python-sqlalchemy python-psycopg2
-
-Enter the pithos dir, copy settings.py.dist to settings.py.
+    apt-get install python-sqlalchemy python-mysqldb python-psycopg2
 
 Then run:
     python setup.py build_sphinx
@@ -32,14 +31,32 @@ Running the server
 
 Make sure you have all required packages installed:
     apt-get install python-django python-setuptools python-sphinx
-    apt-get install python-sqlalchemy python-psycopg2
-
-Enter the pithos dir, copy settings.py.dist to settings.py.
+    apt-get install python-sqlalchemy python-mysqldb python-psycopg2
 
 Then run:
     python manage.py syncdb
-    python manage.py loaddata aai/fixtures/auth_test_data.json (to load sample users)
     python manage.py runserver
 
 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.
+
+Using the tools
+---------------
+
+In the pithos/tools directory you will find the following utilities:
+
+    pithos-sh       Pithos shell
+    pithos-sync     Pithos synchronization client
+    pithos-fs       Pithos FUSE implementation
+    pithos-test     Pithos server tests
+
+Also, the pithos/lib directory contains a python library that can be used
+to access Pithos and manage stored objects. All tools use the included lib.
+
+Connection options can be set via environmental variables:
+
+    PITHOS_USER             Login user
+    PITHOS_AUTH             Login token
+    PITHOS_SERVER           Pithos server (default: plus.pithos.grnet.gr)
+    PITHOS_API              Pithos server path (default: v1)
+    PITHOS_SYNC_CONTAINER   Container to sync with (default: pithos)