nortega/indivisible-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added (un)installation instructions.

Browse Source
This commit is contained in:
Nicolás A. Ortega Froysa
2021-03-03 18:58:07 +01:00
parent bd3e48256f
commit 0e59a7154d
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README
View File

@@ -3,13 +3,18 @@
=================== ===================
Indivisible is an optimized prime number generator and tester written in Rust. Indivisible is an optimized prime number generator and tester written in Rust.
# Building # Build & Installation
---------- ----------------------
To build the project you will require the Rust compiler and build To build the project you will require the Rust compiler and build
system, `cargo`. At which point you simply run `cargo build` in the root system, `cargo`. At which point you simply run `cargo build` in the root
directory of the project. To create an optimized release build append directory of the project. To create an optimized release build append
the `--release` flag to the previous command. the `--release` flag to the previous command.
Once a release build has been compiled, you may install Indivisible and
the manpage documentation by running the `install` script. In a similar
manner, you can run the `uninstall` script to remove the previously
installed binary and documentation.
# Usage # Usage
------- -------
The purpose of Indivisible is to find the nth prime and all the primes The purpose of Indivisible is to find the nth prime and all the primes