update c readme

dzcode-io · Apr 1, 2024 · ff4c229 · ff4c229
1 parent 713e9db
commit ff4c229
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/c/README.md b/c/README.md
@@ -7,6 +7,7 @@ Algeria's college hierarchy dataset as a C library
 - [CMake](https://cmake.org/download/) build system (minimum required version 3.19)
 - [Conan](https://conan.io/downloads) package manager
 - [Clang](https://clang.llvm.org/get_started.html) or [GCC](https://gcc.gnu.org/releases.html) compiler (on macOS clang comes with the developer tools)
+- [Doxygen](https://www.doxygen.nl/download.html) docs generator
 - Any IDE out there, preferably [VSCode](https://code.visualstudio.com/download) with the following extensions:
   - [C/C++](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)
   - [CMake](https://marketplace.visualstudio.com/items?itemName=twxs.cmake)
@@ -24,6 +25,11 @@ Algeria's college hierarchy dataset as a C library
 
 https://github.com/dzcode-io/kuliya/assets/48713070/3f693a1c-050d-4ee2-bfce-9ade59e772ed
 
+- To build docs locally:
+  ```sh
+  cd c && doxygen
+  ```
+
 # Usage
 
 ```c