Skip to content

Commit 9475ac6

Browse files
committed
chore: added rustup recommendations
1 parent 3f598d5 commit 9475ac6

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,27 @@ See `scripts/complex-scheme.sh` for a related example.
2222

2323
---
2424

25+
## Setup
26+
27+
If you're using rustup, it's recommended to add the musl target for static compilation:
28+
29+
```bash
30+
$ rustup target add x86_64-unknown-linux-musl
31+
```
32+
33+
Then build with the alkali feature flag for best performance:
34+
35+
```bash
36+
$ cargo build --release -F alkali --target x86_64-unknown-linux-musl
37+
```
38+
39+
Alternatively, you can use the provided Nix flake which automatically sets up the musl environment:
40+
41+
```bash
42+
$ nix develop
43+
$ cargo build --release -F alkali --target x86_64-unknown-linux-musl
44+
```
45+
2546
## CLI quick‑start
2647

2748
Note: salt is a hex encoded string of 16 bytes. It's good enough to generate it once and reuse for multiple keys. You can generate with:

0 commit comments

Comments
 (0)