Skip to content

Commit aeee473

Browse files
committed
docs: update README.md to align with current state
- Fix directory reference: packages → pkgs - Remove outdated ci.nix reference - Add required sudo prefix for darwin-rebuild (25.05) - Remove git pre-commit section (repo uses jj)
1 parent 9608bae commit aeee473

File tree

1 file changed

+3
-35
lines changed

1 file changed

+3
-35
lines changed

README.md

Lines changed: 3 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ If have a suggestion to improve something, feel free to open an
2828
├── lib # high level nix functions used in this repo
2929
├── modules # reusable parts of nix config used in this repo
3030
├── overlays # customizations on existing nixpkgs used in this repo
31-
├── packages # my packages
31+
├── pkgs # my packages
3232
├── templates # templates as starting points
33-
├── users # user's $HOME configs
34-
└── ci.nix # the nix develop env used during CI/CD runs
33+
└── users # user's $HOME configs
3534
```
3635

3736
## Getting started
@@ -91,7 +90,7 @@ with the terminal. For rebuilds after configuration changes it's only
9190
to run
9291

9392
```bash
94-
darwin-rebuild switch --flake $HOME/path/to/flake-dir
93+
sudo darwin-rebuild switch --flake $HOME/path/to/flake-dir
9594
```
9695

9796
## Development
@@ -116,37 +115,6 @@ in the Home Manager project. To let direnv know that it should use the
116115
shell definition provided by this Flake, the `.envrc` file is needed with
117116
the content `use flake`.
118117

119-
### Git pre-commit checks
120-
121-
Git pre-commit checks uses the [Git Hooks Mechanism](https://git-scm.com/book/ms/v2/Customizing-Git-Git-Hooks)
122-
to call an executable before committing changes to you local git repository.
123-
124-
This enables you to define some checks you like to perform, eg. to prevent you
125-
committing secrets, malformed source code or other stuff you don't like to see
126-
in the repo.
127-
128-
As a lot of checks are probably similar for many developers, the project
129-
[pre-commit.com](https://pre-commit.com) provides a flexible tooling to declare
130-
and integrate checks for this Git Hook.
131-
132-
The Nix Developer Shell in this repo integrates the pre-commit.com tooling and
133-
uses activate some checks for the pre-commit stage.
134-
135-
It's automatically activated entering the nix shell the first time and can be
136-
manual prepared performing a command in the nix shell.
137-
138-
```bash
139-
# Executing a command in the subshell to trigger the pre-commit shell activation
140-
nix develop --command true
141-
```
142-
143-
During regular commits, pre-commit only performs checks on file staged for
144-
commit. A check on all files in the repo can be executed with the followin
145-
command:
146-
147-
```bash
148-
nix develop --command pre-commit run --all-files
149-
```
150118

151119
### CI/CD
152120

0 commit comments

Comments
 (0)