Skip to content

Commit bfb0dc5

Browse files
README: Add instructions to build from master
1 parent 9648f80 commit bfb0dc5

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,20 @@ $ python setup.py install --user
4444

4545
The library is ready to use: `import brping`. If you would like to use the command line [examples](/examples) or [tools](/tools) provided by this package, follow the notes in python's [installing to user site](https://packaging.python.org/tutorials/installing-packages/#installing-to-the-user-site) directions (eg `export PATH=$PATH:~/.local/bin`).
4646

47+
#### From master branch
48+
49+
If you wish to build from scratch the project using master branch or wip pull requests to test, you should compile and generate the definitions file:
50+
51+
```sh
52+
$ git clone https://github.com/bluerobotics/ping-python.git
53+
$ pip install jinja2
54+
$ cd ping-python
55+
$ git submodule update --init
56+
$ python generate/generate-python.py --output-dir=brping
57+
$ python setup.py install --user
58+
$ python -c "import brping" # It works!
59+
```
60+
4761
## Quick Start
4862

4963
The `bluerobotics-ping` package installs a `simplePingExample.py` script to get started. Place your device's file descriptor (eg. `/dev/ttyUSB0`, `COM1`) after the --device option.

0 commit comments

Comments
 (0)