rust-nix-template/README.md

27 lines
1.2 KiB
Markdown
Raw Normal View History

2023-07-23 15:54:27 +02:00
A template Rust project with fully functional and no-frills Nix support, as well as builtin VSCode configuration to get IDE experience without any manual setup (just open in VSCode and accept the suggestions).
2021-04-10 18:10:57 +02:00
2022-10-02 17:24:04 +02:00
Note: If you are looking for the original template based on [this blog post](https://srid.ca/rust-nix)'s use of `crate2nix`, browse from [this tag](https://github.com/srid/rust-nix-template/tree/crate2nix).
2021-04-10 18:12:49 +02:00
2021-04-10 18:10:57 +02:00
## 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)
2021-04-10 18:17:27 +02:00
- 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.
2021-04-10 18:10:57 +02:00
## Development (Flakes)
2023-06-26 18:37:06 +02:00
This repo uses [Flakes](https://nixos.wiki/wiki/Flakes) from the get-go.
2021-04-07 00:24:07 +02:00
```bash
2021-04-10 18:10:57 +02:00
# Dev shell
2021-04-07 00:24:07 +02:00
nix develop
2021-04-10 18:10:57 +02:00
# or run via cargo
2021-04-07 00:24:07 +02:00
nix develop -c cargo run
2021-04-10 18:10:57 +02:00
# build
nix build
```
2023-07-23 16:10:10 +02:00
We also provide a [`justfile`](https://just.systems/) for Makefile'esque commands.