HACKING.rst: Recommend better method of developer install

1 files changed, 12 insertions, 23 deletions

diff --git a/HACKING.rst b/HACKING.rst
index 8c517c122..f3994f65d 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -7,33 +7,18 @@ Getting Started
 ---------------
 After cloning the BuildStream module with git, you will want a development installation.
 
-To do this::
+To do this, first install ``pip`` and run the following command in the buildstream
+checkout directory::
 
-  sudo ./setup.py develop
+  pip install --user -e .
 
-The above will install some symlinks in system directories but should not effect your
-build directory, you can at any time later uninstall with::
+The above will install some dependencies and also a symlink to your buildstream checkout
+in your local user's python environment, so any changes you make to buildstream will be
+effective for your user.
 
-  sudo ./setup.py develop --uninstall
-
-The benefit of this approach is that any changes you make to your local BuildStream
-checkout will take effect immediately without needing to reinstall later.
-
-To really install BuildStream, you can::
-
-  ./setup.py build
-  sudo setup.py install
-
-To create a source distribution of BuildStream, run::
-
-  ./setup.py sdist
-
-To clean up your directory at any time and be **careful**, enter the directory and run::
-
-  git clean -xdf
-
-This will remove any files not currently tracked by git, so handle the above command with care.
+You can later uninstall the local installation by running::
 
+  pip uninstall buildstream
 
 
 Coding Style
@@ -189,6 +174,10 @@ function to feed arguments to pytest as such::
 
   ./setup.py test --addopts -s
 
+You can always abort on the first failure by running::
+
+  ./setup.py test --addopts -x
+
 
 Adding Tests
 ~~~~~~~~~~~~