Skip to content

Commit 0aa396f

Browse files
committed
docs: add treefmt instructions
1 parent 385c011 commit 0aa396f

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,21 @@ This will produce the `WebSocketWithOpenCV` binary.
110110
> Additionally, you should `exit` the `nix develop` shell and re-run `nix
111111
develop --impure` if you modify any `nix` files.
112112

113+
## Formatter
114+
115+
The `treefmt` autoformatter has been configured in
116+
[treefmt.toml](./treefmt.toml) to automatically format the entire tree.
117+
118+
To invoke it, please install Nix, then run:
119+
120+
```sh
121+
nix fmt
122+
```
123+
124+
We recommend you run this commmand before any commit to ensure your code meets
125+
quality guidelines. Continuous integration will run on all commits to ensure
126+
lints and formatting checks pass.
127+
113128
## Solution without package managers, only Meson
114129

115130
> [!WARNING]

0 commit comments

Comments
 (0)