diff --git a/README.md b/README.md index 4b29676b99..fd35f59615 100644 --- a/README.md +++ b/README.md @@ -89,8 +89,9 @@ where feature detection is not functional. ## Stack usage -Some algorithms use large amounts of stack space. This means that you may need to specify `RUST_MIN_STACK` in your environment. -This for example affects tests. +Some algorithms use large amounts of stack space. This means that you may need +to specify `RUST_MIN_STACK` in your environment. This for example affects +tests. ## Algorithm features diff --git a/oqs-sys/README.md b/oqs-sys/README.md index 39500ab16e..c48a3c4c72 100644 --- a/oqs-sys/README.md +++ b/oqs-sys/README.md @@ -7,6 +7,7 @@ This crate provides the unsafe `ffi` bindings to [liboqs][]. ## Features +* `vendored` (default): Compile the included version of liboqs instead of linking to the system version. * `openssl` (default): Compile with OpenSSL features (mostly symmetric cryptography) * `non_portable`: Don't build a portable library. * `kems` (default): Compile with all KEMs enabled @@ -15,16 +16,10 @@ This crate provides the unsafe `ffi` bindings to [liboqs][]. * `frodokem` * `hqc` * `kyber` - * `ntru` * `ntruprime` - * `saber` - * `sidh` - * `sike` * `sigs` (default): Compile with all signature schemes enabled * `dilithium` * `falcon` - * `picnic` - * `rainbow` * `sphincs`: SPHINCS+ [oqs]: https://openquantumsafe.org diff --git a/oqs/README.md b/oqs/README.md index 4fa09e3968..c7c00a2db6 100644 --- a/oqs/README.md +++ b/oqs/README.md @@ -10,24 +10,19 @@ For the ``ffi`` interface bindings, see ``oqs-sys``. ## Features -* `std`: build with `std` support. This adds handly `Display` and `Error` implementations +* `std`: (default) build with `std` support. This adds handly `Display` and `Error` implementations to relevant types. If you want a `#![no_std]` library, disable this feature (and you probably want to disable the default features because they pull in OpenSSL through `oqs-sys`). * `non_portable`: Don't build a portable library. +* `vendored`: (default) Controls the `oqs-sys/vendored` feature which enables building the included version of liboqs. * `kems` (default): Compile with all KEMs enabled - * `bike` (only on non-Windows) - * `classic_mceliece` - * `frodokem` - * `hqc` - * `kyber` - * `ntru` - * `ntruprime` - * `saber` - * `sidh` - * `sike` + * `bike` (only on non-Windows) + * `classic_mceliece` + * `frodokem` + * `hqc` + * `kyber` + * `ntruprime` * `sigs` (default): Compile with all signature schemes enabled - * `dilithium` - * `falcon` - * `picnic` - * `rainbow` - * `sphincs`: SPHINCS+ + * `dilithium` + * `falcon` + * `sphincs`: SPHINCS+