Skip to content

Commit 1bf042b

Browse files
authored
Update README.md
1 parent 2f992f5 commit 1bf042b

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CLSF Sample Python Base Code (gRPC)
1+
# Sample Python Base Code (gRPC)
22

33
[![Documentation Status](https://readthedocs.org/projects/clsframework/badge/?version=latest)](https://clsframework.github.io/docs/introduction/)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -9,6 +9,8 @@ The Soccer Simulation Server sends the observations to the proxy, which processe
99

1010
For more information, please refer to the [documentation](https://clsframework.github.io/).
1111

12+
You can find more information about the services and messages in the [IDL section](../../3-idl/protobuf.md).
13+
1214
## Quick start
1315

1416
### Preparation
@@ -64,11 +66,18 @@ Then we must run the proxy & the decisionmaking server:
6466
./start-team.sh
6567
```
6668

69+
### Options
70+
71+
- `-t team_name`: Specify the team name.
72+
- `--rpc-port PORT`: Specify the RPC port (default: 50051).
73+
- `-d`: Enable debug mode.
74+
75+
6776
Launch the opponent team, start the monitor app image. press <kbd>Ctrl</kbd> + <kbd>C</kbd> to connect to the server, and <kbd>Ctrl</kbd> + <kbd>K</kbd> for kick-off!
6877

6978
### Tutorial Video (English)
7079

71-
TDB
80+
[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/hH-5rkhiQHg/0.jpg)](https://www.youtube.com/watch?v=hH-5rkhiQHg)
7281

7382
### Tutorial Video (Persian)
7483

0 commit comments

Comments
 (0)