diff options
Diffstat (limited to 'README.txt')
| -rw-r--r-- | README.txt | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..c924c81 --- /dev/null +++ b/README.txt @@ -0,0 +1,46 @@ +C S P R S G +----------- +Conjecturally Secure Pseudo-Random Spreadsheet Generator + + +REQUIREMENTS +------------ +You need the Rust toolchain installed (rustup). +<https://rustup.rs> + + +COMPILATION +----------- +1. Open your terminal in the project folder. +2. Build the project in release mode: + cargo build --release + +The executable will be generated at: target/release/csprsg +For easier access, you can move the executable somewhere else: + +cp target/release/csprsg ~/your/desired/dir + + +USAGE +----- +Run the executable, `spreadsheet.ods` will be generated at the current working directory. + +./csprsg + + +LICENSE +------- +This project is licensed under either of: + +- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) + +at your option. + + +THIRD-PARTY LICENSES +-------------------- +This project uses third-party dependencies. +Compliance is maintained via cargo-deny and cargo-about. +For a full list of transitive dependencies and their licenses, see: +THIRD-PARTY-LICENSES.html |
