notedeck/README.md

# Damus Android

A multiplatform nostr client. Works on android and desktop

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. 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/
android branch 2023-11-29 04:32:40 +00:00			`# Damus Android`

			`A multiplatform nostr client. Works on android and desktop`

			`Alpha! WIP!`

framed shot 2023-11-29 04:38:39 +00:00			`<img src="https://cdn.jb55.com/s/bebeeadf7001fae1.png" height="500px" />`
Initial commit 2022-11-06 05:12:17 +00:00
compilation instructions 2023-11-29 04:43:40 +00:00			`## 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`
			```

add cargo-apk and aarch64-linux-android target I tried the nix-shell and that's what was missing for me to build the apk. The desktop app worked out of the box. Closes: https://github.com/damus-io/android/pull/1 Reviewed-by: William Casarin <jb55@jb55.com> Signed-off-by: William Casarin <jb55@jb55.com> 2023-11-29 09:57:27 +00:00			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`
			```
compilation instructions 2023-11-29 04:43:40 +00:00
			`You can also just type`

			```bash
			`$ cargo run --release`
			```

			`To run the multiplatform desktop version of the app called NoteDeck.`


			`[direnv]: https://direnv.net/`