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

Simplify README.md

Browse Source
This commit is contained in:
Nicolás A. Ortega Froysa
2025-12-10 15:06:27 +01:00
parent 966574dd1f
commit 084aa14026
1 changed files with 16 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -1,38 +1,29 @@
# Indivisible # Indivisible
Indivisible is an optimized prime number generator and tester written in Rust. Indivisible is an optimized prime number generator and tester.
## Build & Installation ## Build & Installation
To build the project you will require the Rust compiler and build Build a binary release using the following command:
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 ```console
the manpage documentation by running the `install` script. In a similar $ cargo build -r
manner, you can run the `uninstall` script to remove the previously ```
installed binary and documentation.
## Usage Once compiled, you can install it using the `install` script. By default this
will install to `/usr/local/{bin,share}`, but you can optionally change the
`PREFIX` used as follows:
The purpose of Indivisible is to find the nth prime and all the primes ```console
before it. The basic usage is `indivisible <n>` where `n` is the ordinal $ PREFIX="~/.local" ./install
of the prime you'd like to find. To display all primes before `n`, you ```
can run verbose mode by using the `--verbose` or simply `-v` option.
Since Indivisible generates primes using previously computed primes, you Additionally there is an `uninstall` script available. If you have used a custom
can also import prime numbers previously computed with the `--import` or `PREFIX` this must also be specified to uninstall in the same manner. To see
`-i` option. To store already computed primes you are expected to use where you've installed it you can always use the following command:
piping like any UNIX user would expect. Here is an example:
```bash ```console
# store first 100 primes in ./primes $ which indivisible
indivisible -v 100 > ./primes
# appends next 400 primes
indivisible -i ./primes -v 500 >> ./primes
# display the 600th prime
indivisible -i ./primes 600
``` ```
## Legacy ## Legacy