summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL12
1 files changed, 12 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..ff00242
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,12 @@
+
+To install, initialize cmake in a build directory, e.g.,
+
+# mkdir build
+# cd build
+# cmake ..
+# make
+
+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.
+