aboutsummaryrefslogtreecommitdiff
path: root/server
diff options
context:
space:
mode:
Diffstat (limited to 'server')
-rw-r--r--server/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/server/README.md b/server/README.md
new file mode 100644
index 00000000..447bf264
--- /dev/null
+++ b/server/README.md
@@ -0,0 +1,11 @@
+# Hurry Curry! Server (and others)
+
+## Building
+
+- Requires a rust toolchain with the version specified `/rust-toolchain`
+- Run `cargo build`
+
+The server needs the [game data](../data/README.md) to function. Release builds
+only check typical system installation paths or the windows registry. Debug
+builds (without `--release`) will also check for a `data` folder in the working
+directory.