summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorseth <[email protected]>2023-03-06 10:06:40 -0500
committerseth <[email protected]>2023-03-06 10:07:00 -0500
commit08224d0cda2374648cfe4e8400f5f6643be06751 (patch)
tree434918a534eae39a2aa5b9505abbe269aee06e3d /README.md
parentbb057765034c9fa8b93d92218d2b0a2686e680de (diff)
feat(infra): add pre-commit hooks and devshell
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/README.md b/README.md
index 0338820..76fd673 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ see [PACKAGES.md](https://github.com/getchoo/overlay/blob/main/PACKAGES.md)
## how to use
-### flake configuration:
+### flake configuration
```nix
{
@@ -38,7 +38,7 @@ see [PACKAGES.md](https://github.com/getchoo/overlay/blob/main/PACKAGES.md)
}
```
-### home-manager:
+### home-manager
```nix
{
@@ -49,7 +49,7 @@ see [PACKAGES.md](https://github.com/getchoo/overlay/blob/main/PACKAGES.md)
}
```
-### `configuration.nix`:
+### `configuration.nix`
```nix
_: let
@@ -61,17 +61,20 @@ in {
### cli support
-`nixpkgs.overlays` does not configure overlays for tools such as `nix(-)run`, `nix(-)shell`, etc.
-the best way to make this overlay available to them is to add it to your flake registry or `~/.config/nixpkgs/overlays.nix`.
+`nixpkgs.overlays` does not configure overlays for tools
+such as `nix(-)run`, `nix(-)shell`, etc.
-#### flake registry:
+the best way to make this overlay available to them is to
+add it to your flake registry or `~/.config/nixpkgs/overlays.nix`.
+
+#### flake registry
```shell
nix registry add getchoo github:getchoo/overlay
nix run getchoo#treefetch
```
-#### overlays.nix:
+#### overlays.nix
in `~/.config/nixpkgs/overlays.nix` (or a nix file in `~/.config/nixpkgs/overlays/`):