summaryrefslogtreecommitdiff
path: root/INSTALL
blob: 70d233b63388b2ef08adaa42c3dc55f86abc929b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

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, 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