File tree Expand file tree Collapse file tree 1 file changed +36
-9
lines changed
Expand file tree Collapse file tree 1 file changed +36
-9
lines changed Original file line number Diff line number Diff line change 88
99A Status Board for the Small Size League, optimized to show the current game state on a large screen.
1010
11- ## Project setup
11+ ## Usage
12+ If you just want to use this app, simply download the latest [ release binary] ( https://github.com/RoboCup-SSL/ssl-status-board/releases/latest ) .
13+ The binary is self-contained. No dependencies are required.
14+
15+ ### Runtime Requirements
16+ * No software dependencies (except for development, see below)
17+ * 64bit Linux, Windows, OSX (build your 32bit binaries yourself...)
18+ * A reasonable Web-Browser (mostly tested on Chrome)
19+
20+ ## Development
21+
22+ ### Requirements
23+ You need to install following dependencies first:
24+ * Go >= 1.13
25+ * Node
26+ * Yarn
27+
28+ ### Prepare
29+ Download and install to [ GOPATH] ( https://github.com/golang/go/wiki/GOPATH ) :
30+ ``` bash
31+ go get -u github.com/RoboCup-SSL/ssl-status-board/...
1232```
33+ Switch to project root directory
34+ ``` bash
35+ cd $GOPATH /src/github.com/RoboCup-SSL/ssl-status-board/
36+ ```
37+ Download dependencies for frontend
38+ ``` bash
1339yarn install
1440```
1541
16- ### Compiles and hot-reloads for development
17- ```
18- yarn run serve
42+ ### Run the backend
43+ ``` bash
44+ go run cmd/ssl-status-board/main.go
1945```
2046
21- ### Compiles and minifies for production
22- ```
23- yarn run build
47+ ### Run the UI
48+ ``` bash
49+ # compile and hot-reload
50+ yarn serve
2451```
2552
26- ### Lints and fixes files
53+ ### Build self-contained release binary
2754```
28- yarn run lint
55+ ./install.sh
2956```
3057
3158### Rebuild Protobuf code
You can’t perform that action at this time.
0 commit comments