Add README.md with project description and usage instructions

This commit is contained in:
Andrea Moro 2024-11-11 14:34:49 +01:00
parent 411e1e0461
commit a79063fe50

20
README.md Normal file
View file

@ -0,0 +1,20 @@
# RSA Generator in Rust
RSA Generator written in Rust for TPSIT
## Libraries used
```
colog = "1.3.0" -> Better logging
log = "0.4.22" -> Base logging library
num-bigint = { version = "0.4.6", features = ["rand"] } -> BigInt type + BigInt Random Generator
num-traits = "0.2.19" -> Used for conversions
num-primes = "0.3" -> Library used for generating prime numbers
rand = "0.8" -> Random base library
```
## Usage
1. Clone repo
2. Either use `cargo run` or `cargo build`
3. Run the code
4. Cheers!