tweak install/contributing

rande · rande · commit 566bde604d19 · 2014-05-14T18:42:52.000-04:00
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -4,12 +4,15 @@ Contributing
 Thanks for going into this section! This page tries to summaries all information required to contribute to this project.
 Any contribution must have its own unit tests to ensure good quality and avoid regressions.
 
-Unit Tests
-~~~~~~~~~~
 
-Unit tests are important to avoid bugs. The current test suite used nosetests, to run tests::
+Retrieving the code
+~~~~~~~~~~~~~~~~~~~
 
-    make test
+.. code-block::
+
+    git clone https://github.com/rande/python-element.git
+    pip install -e python-element
+    cd python-element
 
 Loading fixtures
 ~~~~~~~~~~~~~~~~
@@ -19,7 +22,17 @@ run the following commands::
 
     make fixtures
 
-Once fixtures are loaded you can start the http webserver with the command::
+Unit Tests
+~~~~~~~~~~
+
+Unit tests are important to avoid bugs. The current test suite used nosetests, to run tests::
+
+    make test
+
+Running code
+~~~~~~~~~~~~
+
+Once fixtures are loaded, you can start the http webserver with the command::
 
     make dev
 
diff --git a/docs/install.rst b/docs/install.rst
@@ -3,9 +3,24 @@ Install
 
 Python Element has been tested with python 2.7 only and might not work with python 3.x.
 
+Short story
+~~~~~~~~~~~
+
+    sudo apt-get install mongodb-server
+    virtualenv --system-site-packages foobar
+    source foobar/bin/activate
+    pip install git+http://github.com/rande/python-element.git
+    python -m element my-project
+    cd my-project
+    python start.py element:demo:fixtures
+    python start.py tornado:start --verbose -d
+
+
 Install services
 ~~~~~~~~~~~~~~~~
 
+The default skeleton required a mongodb server running, this is not mandatory for small website.
+
 .. code-block:: bash
 
     apt-get install mongodb-server
@@ -20,24 +35,23 @@ Virtual Env makes sure there are not conflict with any installed lib by creating
     virtualenv --system-site-packages element
     source element/bin/activate
 
-Install python element code
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. code-block:: bash
-
-    pip install -r requirements_test.txt
+Install python element
+~~~~~~~~~~~~~~~~~~~~~~
 
-Checking installation
-~~~~~~~~~~~~~~~~~~~~~
+You can install the package by using the main code on github
 
 .. code-block:: bash
 
-    make test
+    pip install git+http://github.com/rande/python-element.git
 
-Running dummy site
-~~~~~~~~~~~~~~~~~~
+Setup your first project
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following command will help you creating your first project based on a skeleton website that you can tweak to
+match your needs.
 
 .. code-block:: bash
 
-    make fixtures
-    make dev
+    python -m element my-project
+
+The script will explain the next steps.
diff --git a/element/__main__.py b/element/__main__.py
@@ -22,9 +22,10 @@
     print 
     print "2. You can now run the small demo project:"
     print "  cd %s" % options.destination
-    print "  python start.py tornado:start --host=127.0.0.1 --port=80"
+    print "  python start.py element:demo:fixtures"
+    print "  python start.py tornado:start --verbose -d"
     print 
-    print "3. Open a browser and go to http://127.0.0.1"
+    print "3. Open a browser and go to http://127.0.0.1:5000"
     print ""
     print "--"
     print "Python Element - Thomas Rabaix <thomas.rabaix@gmail.com>"
diff --git a/setup.py b/setup.py
@@ -20,7 +20,10 @@
         "futures",
         "redis",
         "mailer",
-        "ioc"
+        "ioc",
+        "docutils",
+        "pymongo",
+        "python-dateutil"
     ],
     include_package_data = True,
 )
