From c66aa70e5366d397014ed5c564c793664650d414 Mon Sep 17 00:00:00 2001
From: liquidev <liquidev@tutanota.com>
Date: Sat, 24 Aug 2024 20:09:52 +0200
Subject: [PATCH] add README

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d4203f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# rakugaki - digital multiplayer graffiti
+
+rakugaki is a multiplayer paint canvas with programmable brushes!
+
+At the heart of rakugaki is the _brush_ - a little program for manipulating pixels on a _wall_.
+Brushes are written in a tiny programming language called _haku_.
+
+## I wanna try it out!
+
+Since the app is currently in very early alpha stages, there's no public instance at the moment.
+
+You're free to spin up a server for your friends though!
+Here's the setup procedure for production instances.
+
+```sh
+# As of writing this, 1.81 is not yet released, so we have to use Rust nightly.
+rustup toolchain install nightly-2024-08-11
+rustup default nightly-2024-08-11
+rustup target add wasm32-unknown-unknown
+
+# We use `just` to wrangle the process of building the client-side WebAssembly and the server.
+cargo install just
+
+# Now it's time to run
+just port=8080 profile=release
+```
+
+For development, I recommend using `cargo watch` for live reloading.
+`just` defaults to a development configuration.
+
+```sh
+cargo install cargo-watch
+cargo watch -- just
+```
+