aboutsummaryrefslogtreecommitdiff
path: root/pixel-client/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'pixel-client/README.md')
-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`