aboutsummaryrefslogtreecommitdiff
path: root/test-client/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test-client/README.md')
-rw-r--r--test-client/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/test-client/README.md b/test-client/README.md
new file mode 100644
index 00000000..6b7968da
--- /dev/null
+++ b/test-client/README.md
@@ -0,0 +1,21 @@
+# Hurry Curry! Test Client
+
+The test client is mostly used for debugging. It was developed to test the
+server during the game jam when the main client did not exist yet.
+
+## Building
+
+- Requirements:
+ - Nightly rust toolchain (only if locales are required)
+ - esbuild
+
+```
+make test-client
+```
+
+## Usage
+
+- Serve `test-client` directory somehow. With python:
+ `python -m http.server 8080 -d test-client`
+- Start a local game server.
+- Open the page with your browser.