summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKonstantin Ryabitsev <konstantin@linuxfoundation.org>2020-03-19 15:25:05 -0400
committerKonstantin Ryabitsev <konstantin@linuxfoundation.org>2020-03-19 15:25:05 -0400
commit1686b0fbebdbb4557bebb3d1ee316d928d050bc5 (patch)
treee066058a2295c624bab46178ac078e1e91cb5f7c
parent71ba636c17343d81611eb244e6e3e7a610055fe7 (diff)
downloadb4-1686b0fbebdbb4557bebb3d1ee316d928d050bc5.tar.gz
Document how to run from the checkout dir
Anyone who wants a convenient wrapper to run things from the git checkout without installing pip packages can set up a two-liner wrapper script and put it in their path. Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
-rw-r--r--README.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index e1e2b9c..b569e33 100644
--- a/README.rst
+++ b/README.rst
@@ -20,6 +20,15 @@ Upgrading
python3 -m pip install --user --upgrade b4
```
+Running from the checkout dir
+-----------------------------
+If you want to run from the checkout dir without installing the python package,
+just create the following wrapper command and put it in your path::
+
+ #!/bin/bash
+ B4DIR=$HOME/your/path/to/b4-git-repo
+ PYTHONPATH=$B4DIR env python3 $B4DIR/b4/command.py $@
+
Support
-------
For support or with any other questions, please email