moby/brewlog
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(readme): document prek install via uv in Development Setup

Browse source 
prek is a standalone uv-installed binary, not provided by mise install.
When absent from PATH, `prek run -av` fails with a misleading
"failed to run cargo fmt -- --check" message. Add the `uv tool install
prek` step and a note clarifying the failure mode.
This commit is contained in:
Niels Göttsch 2026-07-17 09:06:25 +02:00
parent 9cf8ce5d79
commit 2312315f34
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -147,9 +147,12 @@ sudo apt install -y clang mold pkg-config libssl-dev \
mise trust
mise install # Install all dev tools
mise run install-e2e # Install Chrome for Testing + ChromeDriver
uv tool install prek # Install prek (git hook runner) as a standalone tool
prek install # Install git hooks
```
> **Note:** `prek` is a standalone binary installed via [`uv`](https://docs.astral.sh/uv/) and must be on `PATH`. If it is missing, `prek run -av` cannot invoke `cargo fmt -- --check` and reports `failed to run cargo fmt -- --check` — this is the missing `prek`/toolchain, not a formatting error. Installing `prek` resolves it.
## Contributing
```bash