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

Enable Build On Windows #28

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

AdijeShen
Copy link

Solve Issue #1

Changes Made

  • Changed from dynamic linking (liboqs.so/liboqs.dll) to static linking (liboqs.a)
  • Added liboqs as a git submodule in ./liboqs/
  • Updated build instructions for all platforms

Key Benefits

  1. Simplified installation - no need to install liboqs in system directory
  2. More portable - all dependencies contained within project
  3. Consistent builds across platforms

Documentation Updates

  • Preserved all existing API documentation
  • Maintained all examples and usage instructions
  • Kept original diagrams and status badges
  • Updated only the build/installation sections

@@ -0,0 +1,3 @@
[submodule "liboqs"]
Copy link
Member

Choose a reason for hiding this comment

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

AFAIK, we don't "like" submodules -- or would you be OK with this here, @dstebila @SWilson4 @vsoftco ?

Copy link
Author

Choose a reason for hiding this comment

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

I'm fine with removing the submodules. This will require some documentation updates to reflect the changes. Let me know if you'd prefer this approach.

Copy link
Member

Choose a reason for hiding this comment

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

I'd rather not have the submodule if we can help it. The language wrapper should "just work" with new versions of liboqs as long as the core APIs don't change.

Copy link
Member

Choose a reason for hiding this comment

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

Agreed; our approach so far has been to not include liboqs as a submodule.

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 PR, @AdijeShen -- before going into review detail, I've asked the rest of the team as to whether they're OK with the submodule approach. The change I'd immediate question is the removal of RELEASE.md: If there's no good reason for this (?) please bring it back: As and if someone else starts to maintain this sub project again, there may be an interest to do new releases again...

@AdijeShen
Copy link
Author

AdijeShen commented Nov 1, 2024 via email

Signed-off-by: Huajie Shen <[email protected]>
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.

4 participants