Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(README.md): fix documentation of features #252

Merged
merged 1 commit into from
Oct 23, 2023
Merged

docs(README.md): fix documentation of features #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
7 changes: 1 addition & 6 deletions oqs-sys/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
27 changes: 11 additions & 16 deletions oqs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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+