Fix README.md to work with Doxygen release 1.10.0 (#1775)

* fix link in README.md Signed-off-by: Pravek Sharma <[email protected]> * simplify linux and mac link in README.md Signed-off-by: Pravek Sharma <[email protected]> * update Doxyfile Signed-off-by: Pravek Sharma <[email protected]> * update CI to use /scripts/run_doxygen.sh Signed-off-by: Pravek Sharma <[email protected]> --------- Signed-off-by: Pravek Sharma <[email protected]>
open-quantum-safe · Jun 5, 2024 · 233c205 · 233c205
1 parent 962fd40
commit 233c205
Show file tree

Hide file tree

Showing 3 changed files with 318 additions and 127 deletions.
diff --git a/.github/workflows/unix.yml b/.github/workflows/unix.yml
@@ -14,7 +14,7 @@ jobs:
       - name: Ensure code conventions are upheld
         run: python3 -m pytest --verbose tests/test_code_conventions.py
       - name: Check that doxygen can parse the documentation
-        run: mkdir -p build/docs && doxygen docs/.Doxyfile
+        run: mkdir build && ./scripts/run_doxygen.sh $(which doxygen) ./docs/.Doxyfile ./build
       - name: Validate CBOM
         run: scripts/validate_cbom.sh
 

diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ liboqs is an open source C library for quantum-safe cryptographic algorithms.
 		- [Limitations and Security](#limitations-and-security)
 			- [Platform limitations](#platform-limitations)
 	- [Quickstart](#quickstart)
-		- [Linux/macOS](#linuxmacos)
+		- [Linux and Mac](#linux-and-mac)
 		- [Windows](#windows)
 		- [Cross compilation](#cross-compilation)
 	- [Documentation](#documentation)
@@ -90,7 +90,7 @@ In order to optimize support effort,
 
 ## Quickstart
 
-### Linux/macOS
+### Linux and Mac
 
 1. Install dependencies: