commit 13fcd6f97a5e803f4bd3755413c9d27a28eee69a
parent 3d2c5d0cd3201f0c1f561b5f664d78764729f9b0
Author: Étienne Simon <etienne.jl.simon@gmail.com>
Date: Mon, 6 May 2013 03:05:28 +0200
Add an INSTALL file.
Diffstat:
| A | INSTALL | | | 56 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 56 insertions(+), 0 deletions(-)
diff --git a/INSTALL b/INSTALL
@@ -0,0 +1,56 @@
+====================
+=== Introduction ===
+====================
+
+How to build everything in 3 easy steps:
+ cd build_directory
+ cmake path_to_source
+ make all doc
+
+
+=====================
+=== Prerequisites ===
+=====================
+
+Build scripts:
+ - CMake
+ - GNU make
+
+Binaries:
+ - Boost
+ - Lexical Cast
+ - Program Options
+ - Serialization
+ - Smart Pointers
+ - Test
+ - Tokenizer
+ - CUDA
+ - SQLite3
+ - WALFU
+ - libcore
+ - libnmlp
+
+Developer documentation:
+ - Doxygen
+ - GraphViz (dot)
+
+LaTeX documentation:
+ - pdfLaTeX
+ - tikz-uml
+ - ... (others, installed by default)
+
+
+=============
+=== Notes ===
+=============
+
+When compiling a binary, you may have to set the WALFU_DIR variable manually
+(either with ccmake or by editing CMakeCache.txt), its default value is
+"../WALFU" relatively to the source directory.
+
+The dependence on dot (from GraphViz) is optional, if you don't have dot, you
+can edit doc/Doxyfile.in to change HAVE_DOT from YES to NO.
+
+The UseLatex.cmake script expect the build directory to be different from the
+source directory. If you want to build the LaTeX documentations, you must do an
+out-of-tree build, which is good practice anyway.
