diff --git a/README.md b/README.md index f89faa5..8b4767b 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,25 @@ Alpha! WIP! +## 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/