mirror of
https://gitlab.com/rensa-nix/devshell.git
synced 2025-12-10 21:30:07 +01:00
docs: improve README and add small improvement for usage
This commit is contained in:
parent
312b725620
commit
fd1a84a424
2 changed files with 31 additions and 1 deletions
24
README.md
24
README.md
|
|
@ -2,3 +2,27 @@
|
|||
|
||||
Minimal devshell implementation using Modules.
|
||||
Inspired by [numtide/devshell](https://github.com/numtide/devshell).
|
||||
|
||||
## Features
|
||||
|
||||
- **fast**: due to the NixOS module system it's a bit slower than `pkgs.mkShell`, but only about 10% (still in the tens of milliseconds range)
|
||||
- **minimal**: only contains the bare minimum, the rest should be added with imported modules
|
||||
- **straight forward**: no toml (like numtide/devshell), no abstractions over Nix (like devenv), just a straight forward Nix lib
|
||||
|
||||
## Usage
|
||||
|
||||
Simple example:
|
||||
|
||||
```nix
|
||||
let
|
||||
# make sure to add
|
||||
# inputs.devshell.url = "gitlab:rensa-nix/devshell?dir=lib";
|
||||
# to your inputs
|
||||
devshell = inputs.devshell.lib { inherit pkgs; };
|
||||
in
|
||||
devshell.mkShell {}
|
||||
```
|
||||
|
||||
## Docs
|
||||
|
||||
See [docs](https://devshell.rensa.projects.tf)
|
||||
|
|
|
|||
|
|
@ -5,7 +5,13 @@
|
|||
The absolute minimum to get started:
|
||||
|
||||
```nix
|
||||
devshell.mkShell {}
|
||||
let
|
||||
# make sure to add
|
||||
# inputs.devshell.url = "gitlab:rensa-nix/devshell?dir=lib";
|
||||
# to your inputs
|
||||
devshell = inputs.devshell.lib { inherit pkgs; };
|
||||
in
|
||||
devshell.mkShell {}
|
||||
```
|
||||
|
||||
That's it. You've got yourself a shell. Not very exciting, but it works.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue