Skip to content

README: Add instructions to build from master #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
patrickelectric merged 1 commit into from
May 14, 2024
Merged

README: Add instructions to build from master #138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,20 @@ $ python setup.py install --user

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`).

#### From master branch

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:

```sh
$ git clone https://github.com/bluerobotics/ping-python.git
$ pip install jinja2
$ cd ping-python
$ git submodule update --init
$ python generate/generate-python.py --output-dir=brping
$ python setup.py install --user
$ python -c "import brping" # It works!
```

## Quick Start

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.
Expand Down