diff options
| author | Jaron Kent-Dobias <jaron@kent-dobias.com> | 2018-10-19 14:49:08 -0400 |
|---|---|---|
| committer | Jaron Kent-Dobias <jaron@kent-dobias.com> | 2018-10-19 14:49:08 -0400 |
| commit | aed8d4f0448bae1e68cf4ff2af0fce87768b921c (patch) | |
| tree | 2c6c81abf1423c81fdd83d5588d2363a7efa287d /INSTALL | |
| parent | 7b3928fb77fffaab35ed75fda5c2ff5d8a802fbf (diff) | |
| download | c++-aed8d4f0448bae1e68cf4ff2af0fce87768b921c.tar.gz c++-aed8d4f0448bae1e68cf4ff2af0fce87768b921c.tar.bz2 c++-aed8d4f0448bae1e68cf4ff2af0fce87768b921c.zip | |
updated install and readme files
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 18 |
1 files changed, 15 insertions, 3 deletions
@@ -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 |