diff --git a/README b/README new file mode 100644 index 0000000..ab13c5a --- /dev/null +++ b/README @@ -0,0 +1,22 @@ +=================== +*** Indivisible *** +=================== +Indivisible is an optimized prime number generator written in Rust. + +# Building +---------- +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 +directory of the project. To create an optimized release build append +the `--release` flag to the previous command. + +# Legacy +-------- +This project was originally written in C. It can be found at + + +# License +--------- +This project is licensed under the terms & conditions of the GNU General +Public License version 3 or greater (see `LICENSE` file for more +information).