Skip to content

Commit dcac969

Browse files
author
P Charishma Kumari
committed
Build script to build liboqs
1 parent 0e325cc commit dcac969

2 files changed

Lines changed: 509 additions & 0 deletions

File tree

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,40 @@ This project is not commercially supported. All guidelines and goals for liboqs
113113

114114
### Linux and Mac
115115

116+
#### Option 1: Using the automated build script (Recommended)
117+
118+
1. Get the source:
119+
120+
git clone -b main https://github.com/open-quantum-safe/liboqs.git
121+
cd liboqs
122+
123+
2. Run the build script:
124+
125+
./build_liboqs.sh
126+
127+
The script will automatically:
128+
- Detect your operating system (macOS, Ubuntu/Debian, or NixOS)
129+
- Install all required dependencies (including Python test dependencies on macOS with automatic pip handling)
130+
- Configure and build liboqs with default settings
131+
132+
For custom build options, see the help:
133+
134+
./build_liboqs.sh --help
135+
136+
Examples:
137+
```bash
138+
# Build shared library with debug symbols
139+
./build_liboqs.sh --shared --build-type Debug
140+
141+
# Minimal build with only ML-KEM-768 and ML-DSA-44
142+
./build_liboqs.sh --minimal-build "KEM_ml_kem_768;SIG_ml_dsa_44"
143+
144+
# Build without OpenSSL
145+
./build_liboqs.sh --no-openssl
146+
```
147+
148+
#### Option 2: Manual installation
149+
116150
1. Install dependencies:
117151

118152
On Ubuntu:

0 commit comments

Comments
 (0)