docs: add clear installation guide for Windows and Raspberry Pi#135
Open
Hongwei-Z wants to merge 1 commit intoopen-quantum-safe:mainfrom
Open
docs: add clear installation guide for Windows and Raspberry Pi#135Hongwei-Z wants to merge 1 commit intoopen-quantum-safe:mainfrom
Hongwei-Z wants to merge 1 commit intoopen-quantum-safe:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
While working with
liboqs-python, I noticed that setting up the underlying C library (liboqs) on Windows can be quite challenging for newcomers. The current documentation leaves some room for ambiguity, and following it often leads to environment configuration issues and build errors.After multiple rounds of trial and error, I have summarized a highly concise, beginner-friendly guide that ensures a smooth and straightforward installation on Windows.
Furthermore, as Post-Quantum Cryptography (PQC) research increasingly intersects with IoT and edge computing, many researchers need to deploy these libraries on resource-constrained hardware. To support the research community, I have also contributed an installation guide for Raspberry Pi (ARM) devices.
Key Changes
INSTALL-Windows.md: A streamlined, step-by-step guide to compiling the C library and setting up the Python wrapper on Windows, designed to bypass common pitfalls.INSTALL-RaspberryPi.md: A hardware-specific guide tailored for researchers, detailing dependencies and build steps optimized for Raspberry Pi environments.README.md: Added direct index links to these new guides in the Installation section.I hope these additions reduce the friction for new developers and researchers adopting this excellent library. Let me know if any adjustments are needed!