Permalink
Browse files

updating doc

  • Loading branch information...
1 parent 64c36f0 commit fc2393a1e0833692ddeebc9b16a8ef53cdcf5204 BJ Dierkes committed Jun 29, 2012
Showing with 20 additions and 20 deletions.
  1. +1 −0 README.md
  2. +16 −17 doc/source/dev/quickstart.rst
  3. +3 −3 doc/source/index.rst
View
@@ -37,6 +37,7 @@ More Information
* CODE: http://github.com/cement/
* PYPI: http://pypi.python.org/pypi/cement/
* SITE: http://builtoncement.org/
+ * T-CI: http://travis-ci.org/cement/cement
License
@@ -13,39 +13,38 @@ is easily installed on most platforms either with 'easy_install' or 'pip' or
via your OS distributions packaging system (yum, apt, brew, etc).
-Installing From Git
--------------------
+Installation
+------------
-Currently, the 'master' branch is the current stable version of cement (0.8.x).
-To install Cement you need to checkout the 'portland' branch which is the
-source for development of the next major version of Cement.
+*Installing Stable Versions From PyPI:*
+
+.. code-block:: text
+
+ $ pip install cement
+
+
+*Installing From Git:*
.. code-block:: text
$ git clone git://github.com/cement/cement.git
$ cd cement
- $ git checkout --track -b portland origin/portland
- Branch portland set up to track remote branch portland from origin.
- Switched to a new branch 'portland'
-
$ virtualenv --no-site-packages ~/env/helloworld/
$ source ~/env/helloworld/bin/activate
- (helloworld) $ cd src/cement/
-
(helloworld) $ python setup.py install
To run tests, do the following from the 'root' directory:
.. code-block:: text
- (helloworld) $ pip install nose
+ (helloworld) $ pip install nose coverage
- (helloworld) $ ./utils/run_tests.sh
+ (helloworld) $ python setup.py nosetests
A Simple Hello World Application
@@ -57,8 +56,8 @@ The following is a bare minimum 'helloworld' application.
from cement.core import foundation
+ app = foundation.CementApp('helloworld')
try:
- app = foundation.CementApp('helloworld')
app.setup()
app.run()
print('Hello World')
@@ -264,10 +263,10 @@ handle command dispatch and rapid development.
# Register any handlers that aren't passed directly to CementApp
handler.register(MySecondController)
- # setup the application
- app.setup()
-
try:
+ # setup the application
+ app.setup()
+
# run the application
app.run()
finally:
View
@@ -11,8 +11,8 @@ introduce a standard, and feature-full platform for both simple and complex
command line applications as well as support rapid development needs without
sacrificing quality.
-.. image:: https://secure.travis-ci.org/derks/cement.png
- :target: http://travis-ci.org/#!/derks/cement
+.. image:: https://secure.travis-ci.org/cement/cement.png
+ :target: http://travis-ci.org/#!/cement/cement
Cement core features include (but are not limited to):
@@ -43,7 +43,7 @@ Getting More Information
* CODE: http://github.com/cement/
* PYPI: http://pypi.python.org/pypi/cement/
* SITE: http://builtoncement.org/
-
+ * T-CI: http://travis-ci.org/cement/cement
Older Versions of Cement
------------------------

0 comments on commit fc2393a

Please sign in to comment.