Add INSTALL file for cmake.

git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@9050 48e7efb5-ca39-0410-a469-dd3cf9ba447f

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..f4d75bc
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,60 @@
+************************************************
+* Installation information specific to SimGrid *
+************************************************
+
+The main source of information to compile SimGrid is the project FAQ.
+It is available online from http://simgrid.gforge.inria.fr/doc/faq.html or
+in the doc/ directory of this archive.
+
+Quick way to compile
+====================
+
+In short, the way to compile SimGrid depends on whether you are
+compiling a tar.gz archive or directly from the SVN.
+
+(1) configure SimGrid (both in SVN and archives)
+$ cmake <all options> ./
+
+Main options are:
+  -DCMAKE_INSTALL_PREFIX=<path>: specify where to install SimGrid
+  -Denable_maintainer_mode=on/off: get the maintainer files regenerated automatically
+  -Denable_compile_optimizations=on/off: compile or not with -O0 instead of -O3
+  -Denable_java=on/off: enable or not binding java
+  -Denable_lua=on/off: enable or not binding lua
+  -Denable_ruby=on/off: enable or not binding ruby
+  -Denable_smpi=on/off: enable or not smpi
+See below for other configure options which are common to any project,
+not only SimGrid related.
+
+(2) Compile it
+$ make
+
+(3) Test it (optional)
+$ make check 
+$ ctest
+
+(4) Install it
+$ make install
+
+
+Dependencies
+============
+SimGrid archives do not have any firm dependencies. 
+
+If you want to compile, you must have installed perl and cmake version 2.6 or above.
+In order to improve memory management you should install libpcre.
+
+If you want to compile the java bindings, you have to have a java
+compiler, and the jni.h header file (available from the JDK)
+
+If you want to compile the lua bindings, you have to have lua5.1 executable and liblua5.1-dev. 
+
+If you want to compile the ruby bindings, you have to install ruby executable and ruby-dev version 1.9.
+
+If you want to compile smpi, you should install f2c for use Fortran code.
+
+If you want to compile the GTNetS backend, you have to have a patched
+version of GTNetS installed. The patch lives in the contrib section of
+the SVN.
+
+Again, you should check the FAQ for more information.
\ No newline at end of file

diff --git a/buildtools/Cmake/DefinePackages.cmake b/buildtools/Cmake/DefinePackages.cmake
index 5738bc2..38abac8 100644 (file)
--- a/buildtools/Cmake/DefinePackages.cmake
+++ b/buildtools/Cmake/DefinePackages.cmake
@@ -770,6 +770,7 @@ set(txt_files
        NEWS
        TODO
        configure
+       INSTALL
 )
 
 file(GLOB_RECURSE README_files