summaryrefslogtreecommitdiff
path: root/rust
diff options
context:
space:
mode:
authorArnaud Bailly <arnaud.bailly@iohk.io>2024-10-10 17:27:35 +0200
committerArnaud Bailly <arnaud.bailly@iohk.io>2024-10-10 17:27:42 +0200
commitc511c31fe25045b46a57b11201704ff55207e808 (patch)
treea52175adb3b5264e1d80ea8dfd9baefac32e341d /rust
parent9133a6c9877d3752f8440cd8c9cff25918c468db (diff)
downloadlambda-nantes-c511c31fe25045b46a57b11201704ff55207e808.tar.gz
Instructions to build server
Diffstat (limited to 'rust')
-rw-r--r--rust/README.md18
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`