Files
notedeck/README.md
William Casarin d0efb2ef55 we should just called this damus
Signed-off-by: William Casarin <jb55@jb55.com>
2024-04-11 11:41:28 -07:00

39 lines
859 B
Markdown

# Damus
A multiplatform nostr client. Works on android and desktop
Alpha! WIP!
## Android
Look it actually runs on android!
<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. If you don't have the `aarch64-linux-android` rust target yet, you can install it with:
```
$ rustup target add aarch64-linux-android
```
You can also just type
```bash
$ cargo run --release
```
To run the multiplatform desktop version of the app called NoteDeck.
[direnv]: https://direnv.net/