Skip to content

Commit

Permalink
fix README.make markup
Browse files Browse the repository at this point in the history
  • Loading branch information
svinota committed Nov 13, 2014
1 parent 92010b7 commit 53fa0b6
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.make.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,20 @@ Makefile documentation
Makefile is used to automate Pyroute2 deployment and test
processes. Mostly, it is but a collection of common commands.

Targets
-------

clean
+++++
target: clean
-------------

Clean up the repo directory from the built documentation,
collected coverage data, compiled bytecode etc.

docs
++++
target: docs
------------

Build documentationr. Requires `Sphinx`.
Build documentation. Requires `Sphinx`.

test
++++
target: test
------------

Run tests against current code. Requires `flake8`, `nosetests`,
`coverage`. Command line options:
Expand All @@ -37,15 +35,15 @@ Sample::
Please notice, that by default tests run with wlevel=error,
thus failing on *any* warning.

dist
++++
target: dist
------------

Make Python distribution package. Command line options:

* python -- the Python to use

install
+++++++
target: install
---------------

Buidl and install the package into the system. Command line options:

Expand All @@ -54,7 +52,7 @@ Buidl and install the package into the system. Command line options:
* lib -- where to install lib files

other targets
+++++++++++++
-------------

Other targets are either utility targets to be used internally,
or hooks for related projects. You can safely ignore them.

0 comments on commit 53fa0b6

Please sign in to comment.