Skip to content

Commit 453468d

Browse files
committed
Clarify local running of hdi, and build process
1 parent 4bd29eb commit 453468d

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

DEVELOPMENT.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
# Development
22

3-
## Git hooks
3+
## Usage
44

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/`.
5+
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
616

717
A pre-commit hook is included that automatically rebuilds `hdi` when `src/` files are staged. To install it:
818

0 commit comments

Comments
 (0)