AiC and REST login

[myslice.git] / README

diff --git a/README b/README
index 9d39aa6..7fa6f6e 100644 (file)
--- a/README
+++ b/README
@@ -1,45 +1,63 @@
-This file documents the contents of this module
-change
-Last update 4 DEC. 2014
+Last update 21 MAY. 2015
 
-See the devel/ subdir for more devel-oriented doc.
+Installation
+=================================================================
+Complete Guide: http://trac.myslice.info/wiki/Manifold/Install
 
-==================== 1 minute howto
+Recommended OS
+===============
+Debian GNU/Linux 7.5 (wheezy) x64
 
-*  REQUIREMENTS  is to have python + django (1.5.2) installed django
-** should be straightforward
-** see devel/django-install.txt in case of trouble
-$ apt-get install python-django
+PYTHON DEPENDENCIES
+=====================
+sudo apt-get install python-pip or sudo easy_install pip==1.4.1
+sudo apt-get install python-dev (for paramiko and pyOpenSSL)
+sudo apt-get install libffi-dev (for pyOpenSSL)
+
+$ pip install django=="1.5.2"
 $ apt-get install python-django-south
-$ apt-get install python-pip or sudo easy_install pip==1.4.1
 $ pip install requests
 $ pip install djangorestframework
 $ pip install django-celery
-* git clone git://git.onelab.eu/myslice.git
--- or --
-* git clone ssh://yourlogin@git.onelab.eu/git/myslice.git
+$ pip install geopy
+$ pip install paramiko
+$ pip install pyparsing
+$ pip install python-dateutil
+$ pip instal pyOpenSSL
+$ pip install xmltodict
 
-* edit/create myslice/myslice.ini and enter the details of your manifold backend
+MYSLICE
+=======
+git clone ssh://yourlogin@git.onelab.eu/git/myslice.git
+cd myslice
+git checkout onelab
+
+edit/create myslice/myslice.ini and enter the details of your manifold backend
 
-$ apt-get install python-django-south
-* init django
-** when django prompts for creating an admin account, create it and 
-** keep the username and password safe
 $ ./manage.py syncdb
 $ ./manage.py migrate
+$ ./manage.py collectstatic
+
+Run the development server
+$ ./devel/server-loop.sh
+
+MANIFOLD
+==========
+git clone git://git.onelab.eu/manifold.git
+cd manifold
+git checkout devel
+make && make install
 
-* gather static files
-$ ./manage.py collectstatic 
--- or --
-$ ./manage.py collectstatic --noinput
--- or --
-$ make static (which is a shorthand for cleaning up and run manage collectstatic --noinput)
+SFA
+===
+$ git clone -b geni-v3 git://git.onelab.eu/sfa.git
+$ cd sfa 
+$ git checkout geni-v3
 
-* gather templates files 
-  for now we still seem to rely on a make-based templates-collection process
-  that creates templates/ 
-$ make templates [$ make redo (each time when you pull, do that and restart the server)]
+$ make version
+$ python ./setup.py install
 
+=====================================================================
 
 ## Whenever doing a git pull the following operations are recommended: