From f8923543d0a42cb3b9445223ccb98722f48e431c Mon Sep 17 00:00:00 2001 From: Arthur Meyre Date: Thu, 1 Feb 2024 17:10:51 +0100 Subject: [PATCH] chore(doc): update installation to match README - added more clearly the information for x86 windows machines --- README.md | 7 +++---- tfhe/docs/getting_started/installation.md | 11 +++++++++-- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4ca4b81ddb..5dd225d408 100644 --- a/README.md +++ b/README.md @@ -51,16 +51,15 @@ tfhe = { version = "*", features = ["boolean", "shortint", "integer", "x86_64-un ```toml tfhe = { version = "*", features = ["boolean", "shortint", "integer", "aarch64-unix"] } ``` -Note: users with ARM devices must compile `TFHE-rs` using a stable toolchain with version >= 1.72. - -+ For x86_64-based machines with the [`rdseed instruction`](https://en.wikipedia.org/wiki/RDRAND) -running Windows: ++ For x86_64-based machines with the [`rdseed instruction`](https://en.wikipedia.org/wiki/RDRAND) running Windows: ```toml tfhe = { version = "*", features = ["boolean", "shortint", "integer", "x86_64"] } ``` +Note: You need to use a Rust version >= 1.72 to compile TFHE-rs. + Note: aarch64-based machines are not yet supported for Windows as it's currently missing an entropy source to be able to seed the [CSPRNGs](https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator) used in TFHE-rs. diff --git a/tfhe/docs/getting_started/installation.md b/tfhe/docs/getting_started/installation.md index e5c8964e93..eb59cd4721 100644 --- a/tfhe/docs/getting_started/installation.md +++ b/tfhe/docs/getting_started/installation.md @@ -6,16 +6,23 @@ To use `TFHE-rs` in your project, you first need to add it as a dependency in your `Cargo.toml`. -If you are using an `x86` machine: +If you are using an `x86_64` machine running a Unix-like OS: ```toml tfhe = { version = "0.5.0", features = [ "boolean", "shortint", "integer", "x86_64-unix" ] } ``` -If you are using an `ARM` machine: +If you are using an `ARM` machine running a Unix-like OS: ```toml tfhe = { version = "0.5.0", features = [ "boolean", "shortint", "integer", "aarch64-unix" ] } ``` +If you are using an `x86_64` machines with the [`rdseed instruction`](https://en.wikipedia.org/wiki/RDRAND) running Windows: + +```toml +tfhe = { version = "*", features = ["boolean", "shortint", "integer", "x86_64"] } +``` + + {% hint style="info" %} You need to use a Rust version >= 1.72 to compile TFHE-rs. {% endhint %}