Skip to content

Commit 437b99c

Browse files
committed
doc: expand minimal readme to (minimal +1)
1 parent c41ccfd commit 437b99c

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,18 @@
66

77
---
88

9-
<sub>It is forbidden to modify this readme &rarr; read the comments in <a href="flake.nix"><code>flake.nix</code></a>!</sub>
9+
_A collection of common devshell modules specified via [`numtide/devshell`][devshell]._
10+
11+
## Why?
12+
13+
- Avoid repetition and reuse common best practices.
14+
- Provide a collection of components to "kill the toil" in the devshell in different scenarios.
15+
- Integrate DevShell concerns with the wider config management in `nix`: cross-reference variables.
16+
17+
## Usage
18+
19+
This is a prototype: consult usage with your Resident SRE.
20+
21+
<sub>For more details: &rarr; read the comments in <a href="flake.nix"><code>flake.nix</code></a>!</sub>
22+
23+
[devshell]: https://github.com/numtide/devshell

0 commit comments

Comments
 (0)