diff options
Diffstat (limited to 'rust/README.md')
| -rw-r--r-- | rust/README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/rust/README.md b/rust/README.md index f7148d9..7dfc03b 100644 --- a/rust/README.md +++ b/rust/README.md @@ -22,3 +22,21 @@ The interaction flow is simple: * If the client fails to answer, or answers wrongly, the server keeps sending the same request * If the client's answer is correct, the server sends another term to evaluate and awards 1 point to the client * The `/leaderboard` endpoint provides a crude HTML page listing each clients' current score + +## Building + +This software is written in Rust (sorry @xvdw), so one needs a Rust toolchain installed, then: + +``` +cargo build && cargo test +``` + +## Running + +To run the server: + +``` +cargo run --bin server +``` + +There are `--port` and `--host` arguments should one want to change the defaults `127.0.0.1:8080` |