Skip to content

Commit

Permalink
Add section to CONFIGURE.md link
Browse files Browse the repository at this point in the history
Without it, doxygen (at least, version 1.9.8) gives the following error:
unable to resolve reference to '/liboqs/CONFIGURE.md' for \ref command

This makes scripts/run_doxygen.sh return exit code 1 instead of 0, and
causes `ninja gen_docs` to fail
  • Loading branch information
iyanmv committed Oct 13, 2023
1 parent 7c3a0e9 commit f082dd7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ In order to optimize support effort,
cmake -GNinja ..
ninja

Various `cmake` build options to customize the resultant artifacts are available and are [documented in CONFIGURE.md](CONFIGURE.md). All supported options are also listed in the `.CMake/alg-support.cmake` file, and can be viewed by running `cmake -LAH ..` in the `build` directory.
Various `cmake` build options to customize the resultant artifacts are available and are [documented in CONFIGURE.md](CONFIGURE.md#options-for-configuring-liboqs-builds). All supported options are also listed in the `.CMake/alg-support.cmake` file, and can be viewed by running `cmake -LAH ..` in the `build` directory.

The following instructions assume we are in `build`.

Expand Down

0 comments on commit f082dd7

Please sign in to comment.