Skip to content

Commit aec731b

Browse files
committed
Merge branch 'main' of github.com:VU-ASE/service-template-go
2 parents 7ee70ac + b78e065 commit aec731b

1 file changed

Lines changed: 23 additions & 3 deletions

File tree

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,24 @@
1-
# service-template-go
1+
<h1 align="center">service template for <code>go</code></h1>
2+
<div align="center">
3+
<a href="https://github.com/VU-ASE/service-template-go/releases/latest">Latest release</a>
4+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
5+
<a href="https://ase.vu.nl/docs/framework/glossary/service">About a service</a>
6+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
7+
<a href="https://ase.vu.nl/docs/framework/glossary/roverlib">About the roverlib</a>
8+
<br />
9+
</div>
10+
<br/>
11+
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 a Go template that incorporates [`roverlib-go`](https://github.com/VU-ASE/roverlib-go), meant to run on the Rover.**
13+
14+
## Initialize a Go service
15+
16+
Instead of cloning this repository, it is recommended to initialize this Go service using `roverctl` as follows:
17+
18+
```bash
19+
roverctl service init go --name go-example --source github.com/author/go-example
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+
224

3-
This is best used in combination with roverctl.
4-
wip, docs soon.

0 commit comments

Comments
 (0)