Skip to content
Snippets Groups Projects
Commit 6b5ba80f authored by Tristan Van Berkom's avatar Tristan Van Berkom
Browse files

doc/source/install.rst: Add a note here about pip's `-e` developer option

It's more suitable to add this note here than to have a separate section
in the HACKING.rst for this.
parent d35896e1
No related branches found
No related tags found
Loading
......@@ -87,7 +87,7 @@ requirements you need::
User installation with pip
--------------------------
Once you have the base system dependencies, you can clone the buildstream
Once you have the base system dependencies, you can clone the BuildStream
git repository and install it as a regular user::
git clone https://gitlab.com/BuildStream/buildstream.git
......@@ -97,6 +97,17 @@ git repository and install it as a regular user::
This will install buildstream and it's pure python dependencies directly into
your user's homedir in ``~/.local``
If you are installing as a developer and want to easily test changes
or if you would like to update your BuildStream installation via git,
then you can specify the ``-e`` option when invoking pip::
pip3 install --user -e .
.. warning::
This will run BuildStream directly from your git checkout and will break
if you ever move the git checkout or run ``git clean -xdf``.
Adjust PATH
~~~~~~~~~~~
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment