From aed8d4f0448bae1e68cf4ff2af0fce87768b921c Mon Sep 17 00:00:00 2001 From: Jaron Kent-Dobias Date: Fri, 19 Oct 2018 14:49:08 -0400 Subject: updated install and readme files --- INSTALL | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) (limited to 'INSTALL') diff --git a/INSTALL b/INSTALL index ff00242..70d233b 100644 --- a/INSTALL +++ b/INSTALL @@ -1,12 +1,24 @@ -To install, initialize cmake in a build directory, e.g., +To build all examples and install the library, initialize cmake in a build +directory, e.g., # mkdir build # cd build # cmake .. # make +# make install The core library requires only the standard C++ libraries and a modern -compiler. Most of the example code also has no dependencies. Compilation of -examples/tools/analyze_correlations.cpp requires the FFTW3 library. +compiler. Most of the example code also has no dependencies, with the exception +of ising_animation, which requires the glut library. + +The documentation can be built into a variety of formats using Sphinx. To list available options, + +# cd doc +# mkdir _build +# make + +Building the documentation on the website is accomplished by then running + +# make html -- cgit v1.2.3-70-g09d2