youwen5/cartographer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme: add some more instructions

Browse source
This commit is contained in:
Youwen Wu 2024-09-12 01:39:53 -07:00
parent 63a6c65901
commit 892112e568
Signed by: youwen5
GPG key ID: 865658ED1FE61EC3
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -11,8 +11,23 @@ Install Nix with flakes.
nix build
```
Or run without installing:
Or run directly:
```sh
nix run "git+https://code.youwen.dev/youwen5/cartographer.git"
```
You may also be able to compile it manually using `cargo` but this is not
officially supported. Use the latest stable Rust toolchain. You must have
`openssl` and the necessary libraries for Rust to link against.
## Hacking
You can enter a development shell with all of the required dependencies
(including `openssl`) with
```bash
nix develop
```
Or use [direnv](https://direnv.net/) and simply `direnv allow`.