+See the devel/ subdir for more devel-oriented doc.
+
+==================== 1 minute howto
+
+* 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
+$ apt-get install python-django-south
+
+* git clone git://git.onelab.eu/myslice.git
+-- or --
+* git clone ssh://yourlogin@git.onelab.eu/git/myslice.git
+
+* edit myslice/config.py and enter the details of your manifold backend
+
+$ apt-get install python-django-south
+* init django
+$ ./manage.py syncdb
+$ ./manage.py migrate
+
+* 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)
+
+* 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)]
+
+
+## Whenever doing a git pull the following operations are recommended:
+
+$ make static # will refresh static/ from all the pieces in the project
+$ make templates # same, for templates
+$ make redo-static # clears up (rm -rf) static/ first, then make static
+$ make redo-templates # ditto for templates
+$ make redo == make redo-static redo-templates
+
+
+* run a local server:
+$ ./manage.py runserver 0.0.0.0:8000
+-- or -- my advice:
+$ devel/server-loop.sh
+when you just need to hit ^C yourself when your static files need to be refreshed - see below
+
+* use it from your browser
+(See more notes on using the development server below)
+
+* install dependencies
+$ pip install -r path/to/requirements/file.txt
+Note. not quite sure what this is about, I could not spot this file..
+
+==================== Status
+
+*** Authentication ***
+
+Should be mostly fine
+Not quite sure if/how the user gets proper notifications when
+. his session has expired (i.e. his frontend is not logged into the backend any longer)
+. his credentials have expired (i.e. the uploaded credentials, e.g. SFA delegated cred)
+ expired and she needs to run e.g. sfi myslice again
+
+Hard-coded accounts (from a very early stage) are gone
+
+
+*** Packaging ***
+
+I've done a very rough attempt at packaging for rpm.
+The logic seems about right but needs more work, in particular in terms of installing myslice.conf
+in the httpd conf.d directory.
+It seems like our app won't work on f14 as is because Django is only 1.3.1 on f14
+Plan is to target f18 but I lack a test machine.
+Also of course I'll try to tackle debian/ubunti at some point.
+
+There also is a working packaging for debian(s) and ubuntu(s) that we use
+on an almost daily basis to upgrade manifold.pl.sophia.inria.fr
+
+
+====================
+
+Third party tools shipped:
+
+* jquery
+* datatables
+* spin
+* bootstrap
+
+Others are added as we build the system when they become needed
+Look in third-party/ for a more detailed list
+
+As a rule of thumb, please try to keep in mind that these will need to
+be upgraded over time I've tried to keep track of the version I picked
+and to have an easy upgrade path (depending on the way the original
+package is published)
+
+==================== Contents: 1st level subdirs
+
+========== code from git
+
+* myslice/
+ this is the django 'project', where to look for
+ . settings.py
+ . urls.py
+
+* manifold/
+ the code for dealing with queries, sending them to the backend, and offering the /manifold/proxy/ URL
+
+* unfold/
+ the code for building / rendering plugins
+
+* plugins/
+ the actual code for plugins
+
+* auth/
+ a django 'app' that deals with authentication; see especially
+ auth.backend.MyCustomBackend
+ for how to use a separate authentication system,
+ as well as settings.py for how to enable it
+
+* ui/
+ provides building blocks for the UI, especially layouts (1 or 2 columns) as
+ well as the topmenu widget
+ + some global static files (css, js, images..)
+
+* portal/
+ this is where the first implementation of myslice, with complete
+ user-management including registration, is taking place
+
+* trash/
+ rough/preliminary scaffolding views are in here
+ as the name suggests this is temporary