Skip to content

Commit 14b0a48

Browse files
committed
[doc] Update readmes
1 parent 847d318 commit 14b0a48

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,20 @@ The ssl-refbox that will be introduced at RoboCup 2019
66

77
## Project setup
88

9+
### Requirements
10+
You need to install Go and setup the GOPATH first.
11+
912
### Development
1013
Run the backend:
1114
```bash
12-
go build
13-
./ssl-game-controller
15+
cd cmd/ssl-game-controller
16+
go install
17+
cd ../..
18+
ssl-game-controller
1419
```
20+
Or use the provided IntelliJ run configuration.
1521

16-
Run the [UI](ui/README.md)
22+
Then, run the [UI](ui/README.md).
1723

1824
### Production / Release
19-
Will be different, but yet to setup ;)
25+
Will be different, but yet to be setup ;)

ui/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
The UI part of ssl-refbox
44

55
## Project setup
6+
Install `npm`, then install the project dependencies:
67
```
78
npm install
89
```

0 commit comments

Comments
 (0)