Skip to content

Commit 50b1ea6

Browse files
authored
Update README.md
1 parent 6679fe5 commit 50b1ea6

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,18 @@ Hyperloop UPV's Control Station is a unified software solution for real-time mon
1010

1111
Download the last release, unzip it and leave the executable compatible with your OS in the folder.
1212

13+
### Usage
14+
15+
When using the Control Station make sure that you have configured your IP as the one specified in the ADJ—usually `192.168.0.9`. Then make sure to configure the boards you'll be making use of in the `config.toml` (at the top of the file you'll be able to see the `vehicle/boards` option, just add or remove the boards as needed following the format specified in the ADJ.
16+
17+
To change the ADJ branch from `main`, change the option `adj/branch` at the end of the `config.toml` with the name of the branch you want to use or leave it blank if you'll be making use of a custom ADJ.
18+
1319
### Developing
1420

1521
The main project file is inside `backend/cmd`. Ensure you have the proper `config.toml` configuration and are in the `develop` branch. To build the project, just run `go build` inside the folder. With everything set up, execute the `cmd` executable, then move to `ethernet-view` and run `npm run dev`, then to the `control-station` and do the same.
1622

23+
If you want to test the app in your local enviorement make use of the locahost—make sure to configure the full range of `127.0.0.X`. The `software` ADJ branch is recommended but you can create your own or use a local branch, in such case make sure to leave blank the `adj/branch` option in the `config.toml`.
24+
1725
### Contributing
1826

1927
See [CONTRIBUTING.md](./CONTRIBUTING.md) for ways to contribute to the Control Station.

0 commit comments

Comments
 (0)