aboutsummaryrefslogtreecommitdiff
path: root/server/README.md
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2025-07-13 16:44:00 +0200
committermetamuffin <metamuffin@disroot.org>2025-07-13 21:14:21 +0200
commit10ef9cc31c82ada3625eab232d8c4b81a1356f1a (patch)
treef341e595d20dc02b52a7a9d2cf661acfdedff31f /server/README.md
parent8c009e07a3b40b44cc03d54a189de2df76118a53 (diff)
downloadhurrycurry-10ef9cc31c82ada3625eab232d8c4b81a1356f1a.tar
hurrycurry-10ef9cc31c82ada3625eab232d8c4b81a1356f1a.tar.bz2
hurrycurry-10ef9cc31c82ada3625eab232d8c4b81a1356f1a.tar.zst
Split off component-specific content into seperate readme files
Diffstat (limited to 'server/README.md')
-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.