Skip to content

Commit

Permalink
Refactoring from markdown to restructured test syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
CalumJEadie committed Sep 18, 2012
1 parent d1fa34e commit 3303fb4
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 118 deletions.
24 changes: 16 additions & 8 deletions README.rst
Expand Up @@ -17,12 +17,14 @@ Example
The build script is written in pure Python and microbuild takes care of managing
any dependancies between tasks and generating a command line interface.

Tasks are just regular Python functions marked with the `@task()` decorator. Dependancies
are specified with `@task()` too. Tasks can be ignored with the `@ignore` decorator.
Tasks are just regular Python functions marked with the ``@task()`` decorator. Dependancies
are specified with ``@task()`` too. Tasks can be ignored with the ``@ignore`` decorator.

After defining all tasks `build(sys.modules[__name__],sys.argv[1:])` is called to
After defining all tasks ``build(sys.modules[__name__],sys.argv[1:])`` is called to
run the build.

::

# example.py
import sys
from microbuild.microbuild import task,build
Expand Down Expand Up @@ -53,7 +55,9 @@ run the build.
The command line interface and help is automatically generated. Task descriptions
are extracted from function docstrings.


::
$ ./example.py -h
usage: example.py [-h] task

Expand All @@ -70,7 +74,9 @@ are extracted from function docstrings.
images Prepare images.
Dependancies between tasks are taken care of too.


::
$ ./example.py android
[ example.py - Starting task "clean" ]
Cleaning build directory...
Expand All @@ -88,15 +94,17 @@ Installation

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

Using pip:
Using pip::

$ pip microbuild

Using easy_install:
Using easy_install::

$ easy_install microbuild
License
=======

microbuild is licensed under a MIT license. See `LICENSE.txt] https://github.com/CalumJEadie/microbuild/blob/master/LICENSE.txt`_.
microbuild is licensed under a MIT license. See `LICENSE.txt`_.

.. _LICENSE.txt: https://github.com/CalumJEadie/microbuild/blob/master/LICENSE.txt
110 changes: 0 additions & 110 deletions README.txt

This file was deleted.

0 comments on commit 3303fb4

Please sign in to comment.