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

Add instructions on how to build shared/dynamic library to the README #1077

Merged
merged 3 commits into from
Aug 23, 2021
Merged

Add instructions on how to build shared/dynamic library to the README #1077

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96c6672
Add instructions on how to build shared/dynamic library
Wandering-Consciousness Aug 20, 2021
5117788
Improve wording and add link to BUILD_SHARED_LIBS section in Wiki
Wandering-Consciousness Aug 22, 2021
2c02ea2
Merge branch 'open-quantum-safe:main' into main
Wandering-Consciousness Aug 22, 2021
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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Various `cmake` build options to customize the resultant artifacts are available

The following instructions assume we are in `build`.

3. The main build result is `lib/liboqs.a`, a static library. The public headers are located in the `include` directory. There are also a variety of programs built under the `tests` directory:
3. By default the main build result is `lib/liboqs.a`, a static library. If you want to build a shared/dynamic library, append [`-DBUILD_SHARED_LIBS=ON`](https://github.com/open-quantum-safe/liboqs/wiki/Customizing-liboqs#build_shared_libs) to the `cmake -GNinja ..` command above and the result will be `lib/liboqs.so|dylib|dll`. The public headers are located in the `include` directory. There are also a variety of programs built under the `tests` directory:

- `test_kem`: Simple test harness for key encapsulation mechanisms
- `test_sig`: Simple test harness for key signature schemes
Expand Down