Skip to content

Commit 0eebe82

Browse files
committed
[doc] Move UI doc to root README and enhance the README
1 parent 8947830 commit 0eebe82

File tree

1 file changed

+39
-12
lines changed

1 file changed

+39
-12
lines changed

README.md

Lines changed: 39 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,51 @@
55

66
# ssl-game-controller
77

8-
The ssl-refbox that will be introduced at RoboCup 2019
8+
The [ssl-refbox](https://github.com/RoboCup-SSL/ssl-refbox) replacement that will be introduced at RoboCup 2019
99

10-
## Project setup
10+
## Usage
11+
If you just want to use this app, simply download the latest [release binary](https://github.com/RoboCup-SSL/ssl-game-controller/releases/latest). The binary is self-contained. No dependencies are required.
12+
13+
## Development
1114

1215
### Requirements
13-
You need to install Go and setup the GOPATH first.
16+
You need to install following dependencies first:
17+
* Go
18+
* NPM
19+
20+
### Compile
21+
```bash
22+
# install dependencies for backend
23+
go get -v -d ./...
1424

15-
### Development
25+
# install dependencies for frontend
26+
npm install
27+
```
28+
29+
### Run
1630
Run the backend:
1731
```bash
18-
cd cmd/ssl-game-controller
19-
go install
20-
cd ../..
21-
ssl-game-controller
32+
go run cmd/ssl-game-controller/main.go
2233
```
23-
Or use the provided IntelliJ run configuration.
2434

25-
Then, run the [UI](ui/README.md).
35+
Run the UI:
36+
```bash
37+
# compile and hot-reload
38+
npm run serve
39+
```
40+
Or use the provided IntelliJ run configurations.
2641

27-
### Production / Release
28-
Will be different, but yet to be setup ;)
42+
### Build self-containing release binary
43+
First, build the UI resources
44+
```bash
45+
# compile and minify UI
46+
npm run build
47+
```
48+
Then build the backend with `packr`
49+
```bash
50+
# get packr
51+
go get github.com/gobuffalo/packr/packr
52+
# install the binary
53+
cd cmd/ssl-game-controller
54+
packr install
55+
```

0 commit comments

Comments
 (0)