Commit 5e084d82 authored by Jason Rhinelander's avatar Jason Rhinelander

Updated requirements in README/BUILD

parent 6d42281b
......@@ -2,16 +2,29 @@
This documents shows the steps used to compiled fracdist from source.
## Requirements
Compiling this program requires a minimum of CMake, perl, and a C++ compiler
supporting the C++11 standard (recent versions of clang and g++ will certainly
work).
Compiling also *optionally* requires `doxygen` and `dot` (from the `graphviz`
package) for generating API HTML documentation (the documentation won't be
generated if . Additionally, if the system has an installation of the Eigen3
and boost headers they will be used; if not, internal copies of the required
headers will be used. If you want to generate the Windows installer, you'll
also need the `nsis` package to be installed.
## Linux, OS X, and similar
From the fracdist directory:
To compile on a unix-like system, from the fracdist directory do:
mkdir build
cd build
cmake ..
make -j4
You can install directly to the system (under /usr/local) using:
You can install directly to the system (usually under /usr/local) using:
make install
......@@ -44,7 +57,7 @@ cmake command:
cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/Windows-mingw32.cmake ..
make -j4
which will give you the binaries and dlls. To build this into a zip use:
which will build the binaries and dlls. To build this into a zip use:
cpack -G ZIP
......@@ -52,7 +65,7 @@ or, for an exe installer:
cpack -G NSIS
(Requires that nsis be installed).
(Requires that the `nsis` package be installed).
You can build both at once using either:
......
......@@ -29,9 +29,9 @@ at https://imaginary.ca/fracdist-api/.
Binary releases of this program have no special requirements, and are available
from https://github.com/jagerman/fracdist/releases.
Compiling this program requires CMake, perl, and a C++ compiler supporting the
C++11 standard (recent versions of clang and g++ will certainly work). See
[BUILDING.md](BUILDING.md) for details.
Compiling this program requires a minimum of CMake, perl, and a C++ compiler
supporting the C++11 standard (recent versions of clang and g++ will certainly
work). See [BUILDING.md](BUILDING.md) for more details.
## License
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment