@@ -113,39 +113,41 @@ 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)
116+ #### Automated Build Script
117117
118- 1 . Get the source :
118+ For a simplified build process, you can use the provided build script that automatically detects your OS, installs dependencies, and builds liboqs :
119119
120- git clone -b main https://github.com/open-quantum-safe/liboqs.git
121- cd liboqs
120+ ``` bash
121+ git clone -b main https://github.com/open-quantum-safe/liboqs.git
122+ cd liboqs
123+ ./build_liboqs.sh
124+ ```
125+
126+ The script supports various build options. View all available options with:
127+
128+ ``` bash
129+ ./build_liboqs.sh --help
130+ ```
122131
123- 2 . Run the build script :
132+ Common examples :
124133
125- ./build_liboqs.sh
134+ ``` bash
135+ # Build shared library with debug symbols
136+ ./build_liboqs.sh --shared --build-type Debug
126137
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
138+ # Minimal build with only ML-KEM-768 and ML-DSA-44
139+ ./build_liboqs.sh --minimal-build " KEM_ml_kem_768;SIG_ml_dsa_44"
131140
132- For custom build options, see the help:
141+ # Build without OpenSSL
142+ ./build_liboqs.sh --no-openssl
133143
134- ./build_liboqs.sh --help
144+ # Build for distribution
145+ ./build_liboqs.sh --dist-build
146+ ```
135147
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- ```
148+ The script automatically handles dependency installation on Ubuntu, macOS (via Homebrew), and NixOS systems.
147149
148- #### Option 2: Manual installation
150+ #### Manual Installation
149151
1501521 . Install dependencies:
151153
0 commit comments