Skip to content

Commit

Permalink
Added contribution and improved installation.
Browse files Browse the repository at this point in the history
Added contribution section, made installation more prominent and corrected pip syntax.
  • Loading branch information
CalumJEadie committed Dec 15, 2012
1 parent 2522fad commit 4a6f612
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ Features
* Manages dependancies between tasks.
* Automatically generates a command line interface.

Installation
============

You can install microbuild from the Python Package Index (PyPI) or from source.

Using pip::

$ pip install microbuild

Using easy_install::

$ easy_install microbuild

Example
=======

Expand Down Expand Up @@ -89,19 +102,18 @@ Dependancies between tasks are taken care of too.
Packaging android app...
[ example.py - Completed task "android" ]

Installation
Contributing
============

You can install microbuild from the Python Package Index (PyPI) or from source.
microbuild is hosted at https://github.com/CalumJEadie/microbuild and contributions are very welcome.

Using pip::
epydoc_ is used for documentation generation and unittest_ for tests.

$ pip microbuild
Run ``build.py apidoc`` to generate documentation and ``build.py test`` to run all unit tests.

Using easy_install::
.. _epydoc: http://epydoc.sourceforge.net
.. _unittest: http://docs.python.org/2/library/unittest.html

$ easy_install microbuild
License
=======

Expand Down

0 comments on commit 4a6f612

Please sign in to comment.