Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 4 commits into from
May 3, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8cb5ed8
fix link in README.md
praveksharma Apr 29, 2024
0c7bacb
simplify linux and mac link in README.md
praveksharma Apr 30, 2024
5661438
update Doxyfile
praveksharma Apr 30, 2024
98eded6
update CI to use /scripts/run_doxygen.sh
praveksharma Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/unix.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -90,7 +90,7 @@ In order to optimize support effort,

## Quickstart

### Linux/macOS
### Linux and Mac

1. Install dependencies:

Expand Down
Loading
Loading