From 7b09f0e237ce092c510882d13e07e202fef397ef Mon Sep 17 00:00:00 2001 From: Nikolai Kristiansen Date: Mon, 21 Oct 2013 15:36:26 +0200 Subject: [PATCH] README updates --- README.md | 44 +++++++++++++++++++------------------------- 1 file changed, 19 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 93977f4..e3f08d6 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,40 @@ -D.U.S.K.E.N -=========== +#D.U.S.K.E.N + Dårlig Utrustet Studentsystem som Kommer til å Endre Norge. -You can find the documentation at [http://dusken.readthedocs.org/](). - - [![Build Status](https://api.travis-ci.org/neuf/dusken.png)](https://travis-ci.org/neuf/dusken) +You can find the documentation at [dusken.readthedocs.org](http://dusken.readthedocs.org/). + +## Installation + +### Manual install: -Installation ------------- See http://edb.neuf.no/wiki/index.php/DUSKEN for installation -**TODO installation:** +### TODO Vagrant install: -Download latest version of Vagrant from [http://downloads.vagrantup.com/]() and then do: +Download latest version of Vagrant from [downloads.vagrantup.com](http://downloads.vagrantup.com/) and then do: vagrant plugin install vagrant-salt vagrant up vagrant ssh -Database Diagram Generation ---------------------------- +## Generate Fixtures for Test + python manage.py dumpdata dusken. -n --indent=4 > dusken/fixtures/.json + +## Database Diagram Generation + sudo apt-get install graphviz libgraphviz-dev pip install pygraphviz django-extensions - python manage.py graph_models -o diagramfile.png main + python manage.py graph_models -o diagramfile.png dusken -Generate Fixtures for Test --------------------------- -`python manage.py dumpdata --all -n > main/fixtures/new-testdata.json` +## Design References +A similar data model might allready [exist](http://www.databaseanswers.org/data_models/generic_foundation/index.htm) [out](http://www.databaseanswers.org/data_models/organisations_and_people_and_transactions/index.htm) [there](http://www.databaseanswers.org/data_models/organisations_and_people/index.htm). +## Developer References -Design References ------------------ - -* Database model: [http://www.databaseanswers.org/data_models/generic_foundation/index.htm]() -* Database model: [http://www.databaseanswers.org/data_models/organisations_and_people_and_transactions/index.htm]() -* Database model: [http://www.databaseanswers.org/data_models/organisations_and_people/index.htm]() - -Developer References --------------------- -* Tastypie: [https://django-tastypie.readthedocs.org/en/latest/]() +* [Tastypie](https://django-tastypie.readthedocs.org/)