Skip to content

Commit b109765

Browse files
authored
chore: unified README
1 parent 30e5db6 commit b109765

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
1-
<h1 align="center"><code>roverlib-python</code> library</h1>
1+
<h1 align="center"><code>roverlib</code> for <code>python</code></h1>
22
<div align="center">
3-
3+
<a href="https://pypi.org/project/roverlib/#history">Latest release</a>
4+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
45
<a href="https://ase.vu.nl/docs/category/roverlib-python">Documentation</a>
6+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
7+
<a href="https://ase.vu.nl/docs/framework/glossary/roverlib">About the roverlib</a>
58
<br />
69
</div>
710
<br/>
811

12+
**When building a service that runs on the Rover and should interface the ASE framework, you will most likely want to use a [roverlib](https://ase.vu.nl/docs/framework/glossary/roverlib). This is the variant for python.**
13+
14+
## Initialize a Go service
15+
16+
You can initialize a service with the Python roverlib using `roverctl` as follows:
17+
18+
```bash
19+
roverctl service init python --name go-example-service --source github.com/author/example-service-service
20+
```
21+
22+
Read more about using `roverctl` to initialize services [here](https://ase.vu.nl/docs/framework/Software/rover/roverctl/usage#initialize-a-service).
23+
924

0 commit comments

Comments
 (0)