From 10ef9cc31c82ada3625eab232d8c4b81a1356f1a Mon Sep 17 00:00:00 2001
From: metamuffin <metamuffin@disroot.org>
Date: Sun, 13 Jul 2025 16:44:00 +0200
Subject: Split off component-specific content into seperate readme files

---
 pixel-client/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 pixel-client/README.md

(limited to 'pixel-client/README.md')

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`
-- 
cgit v1.2.3-70-g09d2