From 460781d40eb955bc661ca65b3dd6df84d839efff Mon Sep 17 00:00:00 2001
From: William Casarin <jb55@jb55.com>
Date: Tue, 28 Nov 2023 20:43:40 -0800
Subject: [PATCH] compilation instructions

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index f89faa5e..8b4767bc 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,25 @@ Alpha! WIP!
 
 <img src="https://cdn.jb55.com/s/bebeeadf7001fae1.png" height="500px" />
 
+## Compiling
+
+The `shell.nix` provides a reproducible build environment for android and rust. I recommend using [direnv][direnv] to load this environment when you `cd` into the directory.
+
+Once you have your dev shell setup, you can build with this command:
+
+```bash
+$ cargo apk run --release 
+```
+
+This will build and run the app on your android device.
+
+You can also just type
+
+```bash
+$ cargo run --release
+```
+
+To run the multiplatform desktop version of the app called NoteDeck.
+ 
+
+[direnv]: https://direnv.net/