aboutsummaryrefslogtreecommitdiff
path: root/pixel-client
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 /pixel-client
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 'pixel-client')
-rw-r--r--pixel-client/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/pixel-client/README.md b/pixel-client/README.md
new file mode 100644
index 00000000..93a0bac0
--- /dev/null
+++ b/pixel-client/README.md
@@ -0,0 +1,19 @@
+# Hurry Curry! Pixel Client
+
+An experimental version of the game that uses pixel-art rendering to allow
+smooth playing even on low-end devices. The pixel client is discontinued however
+and should be rewritten entirely in the future.
+
+## Building
+
+- Requirements:
+ - Nightly rust toolchain
+ - SDL2 development libraries (including gfx, ttf and mixer extensions)
+
+```
+make pixel-client
+```
+
+## Usage
+
+- `./target/release/pixelcurry`