Skip to content

Commit e7c099a

Browse files
authored
Update README.md
1 parent 0b1a497 commit e7c099a

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@
2323
- [Installation](#installation)
2424
- [Install the Library](#install-the-library)
2525
- [Use in External Project](#use-in-external-project)
26-
- [Testing and Coverage](#testing-and-coverage)
26+
- [Testing and Analysis](#testing-and-analysis)
2727
- [Unit Testing](#unit-testing)
28+
- [Sanitizers](#sanitizers)
2829
- [Benchmarks](#benchmarks)
2930
- [Code Coverage](#code-coverage)
3031
- [Contributing](#contributing)
@@ -109,16 +110,6 @@ cmake --preset gcc-RelWithDebInfo
109110
cmake --build --preset gcc-RelWithDebInfo
110111
```
111112

112-
### Sanitizers
113-
114-
The `Sanitize` build type enables runtime checks for memory errors (AddressSanitizer, UndefinedBehaviorSanitizer).
115-
116-
```bash
117-
cmake --preset gcc-Sanitize
118-
cmake --build --preset gcc-Sanitize
119-
ctest --preset gcc-Sanitize
120-
```
121-
122113
## Developer Tooling
123114

124115
### Code Formatting
@@ -189,7 +180,7 @@ cmake -DCMAKE_PREFIX_PATH=/path/to/install ..
189180

190181
> The install includes CMake config files, version info, and targets for linking.
191182
192-
## Testing and Coverage
183+
## Testing and Analysis
193184

194185
This project includes unit tests, benchmarks, and support for code coverage analysis.
195186

@@ -208,6 +199,18 @@ ctest --preset gcc-RelWithDebInfo
208199

209200
> Use `Sanitize` builds to detect memory and undefined behavior.
210201
202+
### Sanitizers
203+
204+
The `Sanitize` build type enables runtime checks for memory errors (AddressSanitizer, UndefinedBehaviorSanitizer).
205+
206+
```bash
207+
cmake --preset gcc-Sanitize
208+
cmake --build --preset gcc-Sanitize
209+
ctest --preset gcc-Sanitize
210+
```
211+
212+
> Enabled by setting `ENABLE_SANITIZERS=ON` (automatically handled via `Sanitizer` preset).
213+
211214
### Benchmarks
212215

213216
Benchmarks are written using **Google Benchmark** and are **not enabled** by default (`ENABLE_BENCHMARKS=OFF`).

0 commit comments

Comments
 (0)