We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 4bd29eb commit 453468dCopy full SHA for 453468d
1 file changed
DEVELOPMENT.md
@@ -1,8 +1,18 @@
1
# Development
2
3
-## Git hooks
+## Usage
4
5
-After editing any file in `src/`, run `./build` to regenerate `hdi`, then commit both. CI will fail if `hdi` is out of date with `src/`.
+Make changes to `src/` files, then run `./build` to regenerate `hdi`.
6
+
7
+Run the `hdi` script directly to test changes before committing:
8
9
+```bash
10
+./hdi
11
+```
12
13
+Both changes in `src/`, and the resulting / built `hdi`, need to be committed. CI will fail if `hdi` is out of date with `src/`.
14
15
+### Git hooks
16
17
A pre-commit hook is included that automatically rebuilds `hdi` when `src/` files are staged. To install it:
18
0 commit comments