Skip to content

Commit 9efcd61

Browse files
committed
Add docs section
1 parent bc07c93 commit 9efcd61

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
- ✅ Clang-format + Clang-tidy + Pre-commit hook
2020
- ✅ GitHub Actions CI for builds, tests, and formatting
2121
- ✅ Install targets
22+
- ✅ Auto-generated API docs via Doxygen
2223

2324
---
2425

@@ -102,6 +103,17 @@ Add this to your CMake call:
102103
cmake -DCMAKE_PREFIX_PATH=/path/to/install ..
103104
```
104105

106+
### Documentation
107+
108+
Documentation is generated using [Doxygen](https://www.doxygen.nl). Docs are built from `Doxyfile`, with output in `docs/html/`.
109+
110+
Generate docs locally:
111+
```bash
112+
doxygen Doxyfile
113+
```
114+
115+
View documentation online: [Modern C++ template](https://ramsafin.github.io/modern-cpp-project-template).
116+
105117
## License
106118

107119
This project is licensed under the [Apache License 2.0](LICENSE).

0 commit comments

Comments
 (0)