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.

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

Conversation

Wandering-Consciousness
Copy link
Contributor

I was trying to build the .NET (C#) wrapper project (liboqs-dotnet) and its README referenced this repo/README to build the oqs shared library but I noticed the README only mentioned that a static library was built. The Golang wrapper did have instructions on how to do so, so for consistency and benefit to future readers, I updated this repo's one too.

No

  • [ no] Does this PR change the input/output behaviour of a cryptographic algorithm (i.e., does it change known answer test values)? (If so, a version bump will be required from x.y.z to x.(y+1).0.)
  • [ no] Does this PR change the the list of algorithms available -- either adding, removing, or renaming? (If so, PRs in OQS-OpenSSL, OQS-BoringSSL, and OQS-OpenSSH will also be required by the time this is merged.)

Copy link
Member

@baentsch baentsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this suggestion: Makes good sense, as not everyone reads/finds the Wiki. Two suggestions for improvement, though: Could you begin section 3 with "By default [the main build result...]" and continue with your addition as written? Second, it may be a good idea to put a hyperlink for BUILD_SHARED_LIBS (to https://github.com/open-quantum-safe/liboqs/wiki/Customizing-liboqs#build_shared_libs). Otherwise LGTM.

@Wandering-Consciousness
Copy link
Contributor Author

Thank you. I've made the changes you suggested.

Copy link
Member

@baentsch baentsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again. LGTM.

@dstebila dstebila merged commit 2c23fa4 into open-quantum-safe:main Aug 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants