github/tfhe-rs
1
1
Fork 0
mirror of https://github.com/zama-ai/tfhe-rs.git synced 2026-01-09 14:47:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

chore(doc): update installation to match README

Browse Source 
- added more clearly the information for x86 windows machines
This commit is contained in:
Arthur Meyre
2024-02-01 17:10:51 +01:00
parent 45befcaf40
commit bba4bcee88
2 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -51,16 +51,15 @@ tfhe = { version = "*", features = ["boolean", "shortint", "integer", "x86_64-un
```toml ```toml
tfhe = { version = "*", features = ["boolean", "shortint", "integer", "aarch64-unix"] } 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 ```toml
tfhe = { version = "*", features = ["boolean", "shortint", "integer", "x86_64"] } 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. 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.

11
tfhe/docs/getting_started/installation.md
View File

@@ -6,16 +6,23 @@
To use `TFHE-rs` in your project, you first need to add it as a dependency in your `Cargo.toml`. 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 ```toml
tfhe = { version = "0.5.0", features = [ "boolean", "shortint", "integer", "x86_64-unix" ] } 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 ```toml
tfhe = { version = "0.5.0", features = [ "boolean", "shortint", "integer", "aarch64-unix" ] } 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" %} {% hint style="info" %}
You need to use a Rust version >= 1.72 to compile TFHE-rs. You need to use a Rust version >= 1.72 to compile TFHE-rs.
{% endhint %} {% endhint %}