Skip to content

Commit cca1ab1

Browse files
committed
update readme
1 parent 304cc0e commit cca1ab1

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,29 @@ See the Getting Started Guide for full steps to configure and use ESP-IDF to bui
5454
Example screenshot of the console output from this app:
5555

5656
![CleanShot 2023-07-12 at 14 01 21](https://github.com/esp-cpp/template/assets/213467/7f8abeae-121b-4679-86d8-7214a76f1b75)
57+
58+
## Developing
59+
60+
If you're developing code for this repository, it's recommended to configure
61+
your development environment:
62+
63+
### Code style
64+
65+
1. Ensure `clang-format` is installed
66+
2. Ensure [pre-commit](https://pre-commit.com) is installed
67+
3. Set up `pre-commit` for this repository:
68+
69+
``` console
70+
pre-commit install
71+
```
72+
73+
This helps ensure that consistent code formatting is applied, by running
74+
`clang-format` each time you change the code (via a git pre-commit hook) using
75+
the [./.clang-format](./.clang-format) code style configuration file.
76+
77+
If you ever want to re-run the code formatting on all files in the repository,
78+
you can do so:
79+
80+
``` console
81+
pre-commit run --all-files
82+
```

0 commit comments

Comments
 (0)