docs: add clear installation guide for Windows and Raspberry Pi#135
docs: add clear installation guide for Windows and Raspberry Pi#135Hongwei-Z wants to merge 1 commit intoopen-quantum-safe:mainopen-quantum-safe/liboqs-python:mainfrom Hongwei-Z:docs-improve-windows-rpi-installHongwei-Z/liboqs-python:docs-improve-windows-rpi-installCopy head branch name to clipboard
Conversation
|
Thanks for the contribution, @Hongwei-Z. I am thinking it might be better to fold a shortened version of this into the main README, both so that it's more prominent, and so that it doesn't need to repeat material present in the main README. What do you think about adding the following as a subsections of "Installation -- Configure, build, and install liboqs"? Platform-specific notesThe instructions above apply to all platforms; the notes below cover Windows. If you do not already have a C++ compiler and CMake, install the Debian-based Linux (including Raspberry Pi). Install the build sudo apt update
sudo apt install -y build-essential cmake ninja-build libssl-dev git python3-pip python3-venvAfter |
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!