rust-nix-template/README.md

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 [install direnv](https://nixos.asia/en/direnv), open in VSCode and accept the suggestions).

>[!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). The evolution of this template can be gleaned from [releases](https://github.com/srid/rust-nix-template/releases).

## Adapting this template

- Run `nix develop` to have a working shell ready before name change.
- Change `name` in Cargo.toml.
- 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)

This repo uses [Flakes](https://nixos.wiki/wiki/Flakes) from the get-go.

```bash
# Dev shell
nix develop

# or run via cargo
nix develop -c cargo run

# build
nix build
```

We also provide a [`justfile`](https://just.systems/) for Makefile'esque commands.

## See Also

- [nixos.wiki: Packaging Rust projects with nix](https://nixos.wiki/wiki/Rust#Packaging_Rust_projects_with_nix)
use direnv 2024-01-20 09:09:43 +01: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 [install direnv](https://nixos.asia/en/direnv), open in VSCode and accept the suggestions).`
Prepare to make a template 2021-04-10 18:10:57 +02:00
readme: note formatting 2023-07-26 20:51:14 +02:00			`>[!NOTE]`
readme: evolution/releases 2023-07-26 20:52:23 +02:00			> 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). The evolution of this template can be gleaned from [releases](https://github.com/srid/rust-nix-template/releases).
Change name 2021-04-10 18:12:49 +02:00
Prepare to make a template 2021-04-10 18:10:57 +02:00			`## Adapting this template`

readme: update for latest 2023-08-05 16:32:18 +02:00			- Run `nix develop` to have a working shell ready before name change.
			- Change `name` in Cargo.toml.
Update readme to work around name change issue #7 2022-04-12 22:30:58 +02:00			- Run `cargo generate-lockfile` in the nix shell
Add cargo-watch, demonstrating addition of build tools 2021-04-12 03:30:21 +02:00			`- 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.`
Prepare to make a template 2021-04-10 18:10:57 +02:00
			`## Development (Flakes)`

Update README 2023-06-26 18:37:06 +02:00			`This repo uses [Flakes](https://nixos.wiki/wiki/Flakes) from the get-go.`
default.nix not required 2021-04-07 00:24:07 +02:00
Add cargo-watch, demonstrating addition of build tools 2021-04-12 03:30:21 +02:00			```bash
Prepare to make a template 2021-04-10 18:10:57 +02:00			`# Dev shell`
default.nix not required 2021-04-07 00:24:07 +02:00			`nix develop`

Prepare to make a template 2021-04-10 18:10:57 +02:00			`# or run via cargo`
default.nix not required 2021-04-07 00:24:07 +02:00			`nix develop -c cargo run`
Prepare to make a template 2021-04-10 18:10:57 +02:00
			`# build`
			`nix build`
			```

readme: note formatting 2023-07-26 20:51:14 +02:00			We also provide a [`justfile`](https://just.systems/) for Makefile'esque commands.
readme: nixos wiki link 2023-10-26 18:41:05 +02:00
			`## See Also`

			`- [nixos.wiki: Packaging Rust projects with nix](https://nixos.wiki/wiki/Rust#Packaging_Rust_projects_with_nix)`