Readme

[myslice.git] / README

diff --git a/README b/README
index d05ded4..69360d3 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 This file documents the contents of this module
-
+change
 Last update 4 sept. 2013
 
 See the devel/ subdir for more devel-oriented doc.
@@ -9,6 +9,8 @@ See the devel/ subdir for more devel-oriented doc.
 *  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 --
@@ -16,7 +18,10 @@ See the devel/ subdir for more devel-oriented doc.
 
 * edit myslice/config.py 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
 
@@ -32,8 +37,18 @@ $ make static (which is a shorthand for cleaning up and run manage collectstatic
   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
+$ ./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
@@ -213,6 +228,12 @@ $python manage.py loaddata temp_data.json
 
 If your changes break your old schema this won't work - in which case tools like south or django evolution are great.
 
+
+Add a new model to the DB
+
+$python manage.py schemamigration <your_app> --auto
+$python manage.py migrate
+
 ======== update django database to reflect changes in existing models with migration system (e.g., south) =========
 
 As south is already installed , you just have to do: