Skip to content

Commit 4f21d46

Browse files
committed
docs: update README to clarify warning behavior in build types [skip ci]
1 parent 5c55101 commit 4f21d46

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Modern C++ Makefile Template
1+
# C++ Makefile Template
22

33
![Make](https://img.shields.io/badge/Build-Make-6D00CC?style=flat&logo=cmake&logoColor=white)
44
![Platform](https://img.shields.io/badge/Platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey?style=flat)
@@ -254,7 +254,7 @@ make WARN_LEVEL=normal CXX=clang++ -j8
254254

255255
### Warning Behavior by Build Type
256256

257-
- **Release builds**: Warnings become errors (`-Werror`) regardless of `WARN_LEVEL`
257+
- **Release builds**: `-Werror` is available but commented out by default — uncomment `#ERRORFLAGS += -Werror` in the makefile to enable it
258258
- **Debug builds**: Warnings remain as warnings for easier iteration
259259

260260
```bash
@@ -323,7 +323,7 @@ MyProject/
323323

324324
### Optional Tools
325325

326-
- `objdump` (for `make disasm`)
326+
- `objdump` (for `make disassemble`)
327327
- `gdb` or `lldb` (debugging)
328328
- `pkg-config` (optional)
329329

0 commit comments

Comments
 (0)