nostr/notedeck
1
0
Fork 0
mirror of https://github.com/damus-io/notedeck.git synced 2024-09-07 23:43:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: make note about not needing nix on ubunutu

Browse Source 
Reported-by: Derek Ross
Fixes: https://github.com/damus-io/notedeck/issues/144
Signed-off-by: William Casarin <jb55@jb55.com>
This commit is contained in:
William Casarin 2024-07-10 09:52:57 -07:00
parent 5805df266a
commit f795fe6088
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -28,6 +28,8 @@ $ ./target/release/notedeck "$(cat queries/timeline.json)" "$(cat queries/notifi
## Desktop (Linux/MacOS, Windows?)
If you're running debian-based machine like Ubuntu or ElementaryOS, all you need is to install [rustup] and run `sudo apt install build-essential`.
First, install [nix][nix] if you don't have it.
The `shell.nix` provides a reproducible build environment, mainly for android but it also includes rust tools if you don't have those installed. It will likely work without nix if you are just looking to do non-android dev and have the rust toolchain already installed. If you decide to use nix, I recommend using [direnv][direnv] to load the nix shell environment when you `cd` into the directory.
@ -107,3 +109,5 @@ Configure the developer environment:
```
This will add the pre-commit hook to your local repository to suggest proper formatting before commits.
[rustup]: https://rustup.rs/