README: add some background and usage docs

This commit is contained in:
Oystein Kristoffer Tveit 2024-12-05 14:23:23 +01:00
parent 002951b308
commit ba375b5ec1
Signed by: oysteikt
GPG Key ID: 9F2F7D8250F35146

View File

@ -1,3 +1,42 @@
# shells # shells
oil This is a collection of general purpose and project specific nix shells.
They are mostly for personal use.
### Add adhoc `.envrc`
The shells can easily be used in a project by creating a `.envrc` file, with contents like:
```
use flake git+ssh://git.pvv.ntnu.no/oysteikt/shells.git#rust
```
I've added `.envrc` to my global gitignore, so I don't accidentally commit these.
### Add to flake registry
```nix
{
# NixOS / home-manager (API is similar)
nix.registry."shells".to = {
type = "git";
url = "https://git.pvv.ntnu.no/oysteikt/shells.git";
ref = "main";
};
}
```
Lets you do this:
```bash
$ nix develop shells#rust
```
As well as shorthands in `.envrc`:
```
use flake shells#rust
```