From 0b42525ea8bb1b5afe8dd0098ff896883b3a0b45 Mon Sep 17 00:00:00 2001 From: "Manu [tennox]" <148720-TeNNoX@users.noreply.gitlab.com> Date: Tue, 12 Apr 2022 22:30:58 +0200 Subject: [PATCH] Update readme to work around name change issue #7 --- Cargo.toml | 2 +- README.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 4d1228e..a0b6d37 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] authors = ["Sridhar Ratnakumar "] 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" version = "0.1.0" diff --git a/README.md b/README.md index 18290be..b402ae7 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ See [Nix-ifying Rust projects](https://notes.srid.ca/rust-nix) for details. ## 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. +- 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. ## Development (Flakes)