Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
renaming the tracing functions that set the host/link utilization
[simgrid.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 1f615b1..7c5877f 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,40 +1,64 @@
- ---------------------------
-(Some notes specific to GRAS)
- ---------------------------
-
-CROSS-COMPILING
-===============
-
-In order to cross-compile the package to windows from linux, you need to
-install mingw32 (minimalist gnu win32). On Debian, you can do so by
-installing the packages mingw32 (compiler), mingw32-binutils (linker and
-so), mingw32-runtime. 
-
-You can use the VPATH support of configure to compile at the same time for
-linux and windows without dupplicating the source nor cleaning the tree
-between each. Just run bootstrap (if you use the CVS) to run the autotools.
-Then, create a linux and a win directories. Then, type:
-  cd linux; ../configure --srcdir=.. <usual configure flags>; cd ..
-  cd win;  ../configure --srcdir=.. --host=i586-mingw32msvc <flags>; cd ..
-After that, you can run all make target from both directories, and test
-easily that what you change for one arch does not break the other one.
-
-Of course, for the test, you can use wine. 
-For that, do not forget to put the mingw32.dll where wine expects it. 
-  cp /usr/share/doc/mingw32-runtime/mingwm10.dll.gz ~/.wine/c/windows/system/
-  gunzip ~/.wine/c/windows/system/mingwm10.dll.gz
-
-Please note that as long as we don't export the symbols the dll way, libtool
-only build a static library. So, the programs cross-compiled do only need
-the mingwm10.dll around (either in the same directory, or in c:\windows).
-
-If you're really curious, check /usr/include/png.h and
-/usr/include/pngconf.h (pkg libpng12-dev) to see how to export the symbols
-the proper way. Search for 'dll' in the libtool info file, too.
-
- --------------------------------
-(The regular INSTALL file follows)
- --------------------------------
+************************************************
+* 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. In the latter
+case, you have to do an extra step (noted 0 below).
+
+(0) regenerate the autotools files (only needed from SVN):
+$ ./bootstrap
+
+(1) configure SimGrid (both in SVN and archives)
+$ ./configure <all options>
+Main options are:
+  --prefix=<path>: specify where to install SimGrid
+  --with-pthreads: use pthreads instead of Unix contextes (less
+                   efficient but maybe easier to debug)
+  --enable-maintainer-mode: get the makefiles regenerated automatically
+  --disable-compiler-optimizations: compile with -O0 instead of -O3
+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 
+     or
+$ ./checkall
+
+(4) Install it
+$ make install
+
+
+Dependencies
+============
+SimGrid archives do not have any firm dependencies. 
+
+If you want to compile from the svn, you have to have autotool,
+automake and libtool installed.
+
+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 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.
+
+****************************************************************************
+* Generic Installation information from autotools                          *
+* (provided for completion at the step where you have to launch configure) *
+****************************************************************************
 
 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
 Foundation, Inc.
@@ -205,7 +229,7 @@ eventually be run) with `--host=TYPE'.
 Sharing Defaults
 ================
 
-   If you want to set default values for `configure' scripts to share,
+<   If you want to set default values for `configure' scripts to share,
 you can create a site shell script called `config.site' that gives
 default values for variables like `CC', `cache_file', and `prefix'.
 `configure' looks for `PREFIX/share/config.site' if it exists, then