From 0e59a7154d694607ec2fb4618ca146bf24a280b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20Ortega=20Froysa?= Date: Wed, 3 Mar 2021 18:58:07 +0100 Subject: [PATCH] Added (un)installation instructions. --- README | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README b/README index 4ab5f26..4523204 100644 --- a/README +++ b/README @@ -3,13 +3,18 @@ =================== 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 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. +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 ------- The purpose of Indivisible is to find the nth prime and all the primes