summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2024-07-06 18:11:56 +0200
committermetamuffin <metamuffin@disroot.org>2024-07-06 18:11:56 +0200
commit420021e6615c6551e2cf53eb411140ed5f854480 (patch)
tree9b78b0f649aa3ddf981f7868ce79d3533c6c1c5a
parent86206fbeff627ac7382ea69d0ab11d7f32de4995 (diff)
downloadhurrycurry-420021e6615c6551e2cf53eb411140ed5f854480.tar
hurrycurry-420021e6615c6551e2cf53eb411140ed5f854480.tar.bz2
hurrycurry-420021e6615c6551e2cf53eb411140ed5f854480.tar.zst
Some doc
-rw-r--r--readme.md35
1 files changed, 34 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index 61b10185..49911be4 100644
--- a/readme.md
+++ b/readme.md
@@ -2,7 +2,40 @@
A cooperative multiplayer game about cooking.
-Very much work in progress
+## Client
+
+### Building
+
+- `cd client`
+- Import all assets: `godot --import .`
+
+### Usage
+
+- `godot .`
+
+## Server
+
+### Building
+
+- Build game data: `make -C data`
+- Build the server program: `cargo build --release`
+
+### Usage
+
+- Run the server: `./target/release/undercooked-server`
+
+## Test Client
+
+### Building
+
+- Compile typescript:
+ `esbuild test-client/main.ts --bundle --outdir=test-client --target=esnext --format=esm`
+
+### Usage
+
+- Serve `test-client` directory somehow. With python:
+ `python -m http.server 8080 -d test-client`
+- Open the page with your browser.
## License