sampleapp/README.txt
changeset 11490 addf68740dbb
parent 11486 cadcedf11b7e
--- a/sampleapp/README.txt	Tue Jul 15 18:25:48 2014 +0200
+++ b/sampleapp/README.txt	Tue Jul 22 23:45:11 2014 +0200
@@ -1,13 +1,41 @@
-sampleapp README
+A sample application to test the pyramid_cubicweb library
+=========================================================
+
+Requirements
+------------
+
+System requirements
+~~~~~~~~~~~~~~~~~~~
 
-Before pip installing cubicweb, the following packages are required (on a
-ubuntu 14.04) :
+On a ubuntu 14.04::
+
+    sudo apt-get install libgecode-dev libxml2-dev libxslt1-dev python-dev \
+    libz-dev libpq-dev libtiff5-dev libfreetype6-dev
+
+Python requirements
+~~~~~~~~~~~~~~~~~~~
+
+::
 
-libgecode-dev
-libxml2-dev
-libxslt1-dev
+    pip install -r requirements.txt
+    (cd .. && python setup.py develop)
+    python setup.py develop
+
+
+Cubicweb instance
+~~~~~~~~~~~~~~~~~
+
+You need a postgresql server.
 
-python-dev
+::
+
+    export CW_MODE=user
+    cubicweb-ctl create blog test
+
 
-libz-dev
-libpq-dev
+Running the app
+---------------
+
+::
+
+    pserve --reload develop.ini