aljaz/notedeck
1
0
Fork 0
mirror of https://github.com/aljazceru/notedeck.git synced 2025-12-17 08:44:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

compilation instructions

Browse Source
This commit is contained in:
William Casarin
2023-11-28 20:43:40 -08:00
parent b5e0ffa4f0
commit 460781d40e
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -6,3 +6,25 @@ Alpha! WIP!
<img src="https://cdn.jb55.com/s/bebeeadf7001fae1.png" height="500px" /> <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/