indivisible-legacy/README

36 lines
1.1 KiB
Plaintext
Raw Normal View History

2018-10-18 10:00:32 +00:00
===================
*** Indivisible ***
===================
2019-09-23 18:44:23 +00:00
A parallelized prime number generator written in C. It uses a bignum
library as well as OpenMPI for parallelization.
2018-10-18 10:00:32 +00:00
# Building
----------
2019-09-23 18:44:23 +00:00
## Dependencies
The dependencies for compiling are minimal, and should be available
on most UNIX-like systems:
- GNU Make
- C99 Compiler (GCC is recommended)
- GNU Multi-Precision Arithmetics Library (GMP)
- OpenMPI
## Compiling
To compile you simply need to run the `make` command, which will
create the `indivisible` binary file. Additionally you can set the
following flags by appending them to the `make` command:
- `DEBUG=<1|0>`: whether to create a debug or release build. (0 by
default)
- `PREFIX=<path>`: what base prefix to install the binaries at.
(`/usr/local` by default)
2018-10-18 10:00:32 +00:00
# Contributing
--------------
2019-09-23 18:44:23 +00:00
To contribute to the project, please follow the same coding style you
see in the current code base. Then, either submit a pull request or send
a patch file to <nicolas@ortegas.org>.
2018-10-18 10:00:32 +00:00
# License
---------
2019-09-23 18:44:23 +00:00
This project is licensed under the terms & conditions of the GNU General
Public License version 3 or greater (see `LICENSE` file).