fix: update README.md to include pre-commit hooks

This commit is contained in:
2025-08-05 17:19:03 -03:00
parent 4ea83d7797
commit efd29765c3

View File

@@ -4,12 +4,12 @@
---
## 🛠 Features
## Features
* C99-compliant codebase
* Basic command-line argument parsing
* Structured logging system
* Ready to clone and rename
- C99-compliant codebase
- Basic command-line argument parsing
- Structured logging system
- Ready to clone and rename
---
@@ -22,7 +22,13 @@ git clone https://git.bzd.gg/brenozd/c-template.git
cd c-template
```
### 2. Replace Project Identifiers
### 2. Initialize pre-commit hooks
```bash
pre-commit install --hook-type commit-msg --hook-type pre-push
```
### 3. Replace Project Identifiers
Substitute all occurrences of `c-template` and `c_template` with your new project's name:
@@ -39,7 +45,6 @@ grep -rl 'c_template' src/ include/ | xargs sed -i "s/c_template/$(echo "$your_p
grep -rl 'C_TEMPLATE' src/ include/ | xargs sed -i "s/C_TEMPLATE/$macro_name/g"
```
---
## Build & Run