Update the README and an entry in the cfg file.
This commit is contained in:
parent
c078940080
commit
f056d8adcb
31
README.rst
31
README.rst
@ -3,6 +3,9 @@ bou
|
||||
|
||||
Bou (pronounced "bow") is a simple builder or task runner which uses a YAML file for task configuration.
|
||||
|
||||
Bou uses the concept of *stages* and *steps*. A stage is a sets of steps, and a step is a set of commands to run. A
|
||||
stage can contain many steps, but a step can only belong to a single stage.
|
||||
|
||||
"Bou" is `Afrikaans`_ for "build".
|
||||
|
||||
Installation
|
||||
@ -14,6 +17,31 @@ Install bou with pip:
|
||||
|
||||
$ pip install bou
|
||||
|
||||
Running bou
|
||||
-----------
|
||||
|
||||
To run bou, simply call it:
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ bou
|
||||
|
||||
To specify a build configuration file, use the ``-f`` option:
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ bou -f /path/to/build.yaml
|
||||
|
||||
To specify a stage or a step to run, just add it to the command
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ bou build
|
||||
$ bou test
|
||||
|
||||
.. note::
|
||||
|
||||
By default, all stages are run, and stages are run in the order in the build configuration file.
|
||||
|
||||
Task Configuration
|
||||
------------------
|
||||
@ -67,4 +95,7 @@ Source Code
|
||||
|
||||
The source code to bou is available on my personal Git server: https://git.snyman.info/raoul/bou
|
||||
|
||||
|
||||
Copyright (c) 2021 Raoul Snyman
|
||||
|
||||
.. _Afrikaans: https://en.wikipedia.org/wiki/Afrikaans
|
||||
|
Loading…
Reference in New Issue
Block a user