toby/rust-nix-template
Template
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update readme to work around name change issue #7

Browse source
This commit is contained in:
Manu [tennox] 2022-04-12 22:30:58 +02:00
parent 1986c2d57e
commit 0b42525ea8
2 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Cargo.toml
View file

@ -1,7 +1,7 @@
[package] [package]
authors = ["Sridhar Ratnakumar <srid@srid.ca>"] authors = ["Sridhar Ratnakumar <srid@srid.ca>"]
edition = "2018" edition = "2018"
# If you change the name here, you must also do it in flake.nix # If you change the name here, you must also do it in flake.nix (and run `cargo generate-lockfile` afterwards)
name = "rust-nix-template" name = "rust-nix-template"
version = "0.1.0" version = "0.1.0"

2
README.md
View file

@ -4,7 +4,9 @@ See [Nix-ifying Rust projects](https://notes.srid.ca/rust-nix) for details.
## Adapting this template ## Adapting this template
- Run `nix develop` to have a working shell ready before name change (Workaround for [an issue](https://github.com/srid/rust-nix-template/issues/7#issuecomment-1097182528)
- Change `name` in Cargo.toml and flake.nix. Also change `description` in flake.nix. - Change `name` in Cargo.toml and flake.nix. Also change `description` in flake.nix.
- Run `cargo generate-lockfile` in the nix shell
- There are two CI workflows, and one of them uses Nix which is slower (unless you configure a cache) than the other that is based on rustup. Pick one or the other depending on your trade-offs. - There are two CI workflows, and one of them uses Nix which is slower (unless you configure a cache) than the other that is based on rustup. Pick one or the other depending on your trade-offs.
## Development (Flakes) ## Development (Flakes)