starting to write docs, taking decisions on public api
This commit is contained in:
34
docs/install.rst
Normal file
34
docs/install.rst
Normal file
@ -0,0 +1,34 @@
|
||||
Installation
|
||||
============
|
||||
|
||||
|
||||
.. todo::
|
||||
|
||||
better install docs, especially on how to use different fork, etc.
|
||||
|
||||
Install with pip
|
||||
::::::::::::::::
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
$ pip install bonobo
|
||||
|
||||
Install from source
|
||||
:::::::::::::::::::
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
$ pip install git+https://github.com/python-bonobo/bonobo.git@master#egg=bonobo
|
||||
|
||||
Editable install
|
||||
::::::::::::::::
|
||||
|
||||
If you plan on making patches to Bonobo, you should install it as an "editable" package.
|
||||
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
$ pip install --editable git+https://github.com/python-bonobo/bonobo.git@master#egg=bonobo
|
||||
|
||||
Note: `-e` is the shorthand version of `--editable`.
|
||||
|
||||
Reference in New Issue
Block a user