Skip to content

Commit 6ed9174

Browse files
committed
chore: updated docs
1 parent cf32a7a commit 6ed9174

2 files changed

Lines changed: 10 additions & 7 deletions

File tree

docs/00-usage.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# Usage
22

3-
After installation, you can use roverlib as follows:
3+
Roverlib comes installed by default on every rover, but if for some reason it isn't, [ssh into the rover](https://ase.vu.nl/docs/tutorials/Fundamental%20Concepts/connecting) and run the following pip install command:
44

5-
```python
5+
``` bash
6+
pip install roverlib
7+
```
8+
9+
After that, you can use it in a script as shown below, refer to the [service-template-python](https://github.com/VU-ASE/service-template-python) for a complete example.
10+
11+
``` python
612
#!/usr/bin/python3
713
import roverlib
814
import signal

docs/01-development.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,7 @@ This repository is self-contained and relies heavily on `uv` for dependency mana
1010

1111
* `make build` - builds the library to `dist/` and installs it locally for quick testing
1212
* `make test` - runs all files in the `tests/` directory
13-
* `make publish-test` - requires setting an external token with `export PUBLISH_TOKEN=pypi-abc...` and uploads to pypi's test
14-
* `make publish` - requires setting an external token with `export PUBLISH_TOKEN=pypi-def...` and uploads to the official pypi index
15-
13+
* `make publish-test` - requires setting an external token with `export UV_PUBLISH_TOKEN=pypi-abc...` and uploads to pypi's test
14+
* `make publish` - requires setting an external token with `export UV_PUBLISH_TOKEN=pypi-def...` and uploads to the official pypi index
1615

1716
Before running the `make publish*` targets, make sure to set the correct token depending on which index you are uploading to.
18-
19-

0 commit comments

Comments
 (0)