Parcourir la source

Add README

With installation/usage instructions
Jocelyn Delande il y a 9 ans
Parent
commit
a0b7c32e79
1 fichiers modifiés avec 29 ajouts et 0 suppressions
  1. 29 0
      README.md

+ 29 - 0
README.md

@@ -0,0 +1,29 @@
+Transparency: detail costs for libre price
+==========================================
+
+It's still alpha-pre-ugly-looking and some strings are mentioning
+[FAImaison](https://faimaison.net), more usable version
+may be integrated to [coin](https://code.ffdn.org/ffdn/coin).
+
+Run it
+------
+
+### First time
+
+    sudo apt-get install python virtualenvwrapper
+    mkvirtualenv transparency
+    pip install -r requirements.txt
+    ./manage.py runserver
+
+### Later
+
+    workon transparency
+    ./manage.py runserver
+
+
+Use it
+------
+
+- Enter data into (yeah, documentation can explain a bit better...)
+  http://localhost:8000/admin/
+- Browse http://localhost:8000 to view costs/details