Skip to content

Commit 4071610

Browse files
committed
readme: elaborate on user site installation
1 parent 803e524 commit 4071610

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,11 @@ $ pip install --user bluerobotics-ping
3636
```sh
3737
$ git clone https://github.com/bluerobotics/ping-python.git
3838
$ cd ping-python
39-
$ python setup.py install
39+
$ python setup.py install --user
4040
```
4141

42+
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`).
43+
4244
## Quick Start
4345

4446
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)