Added sprinkler example
[libdai.git] / README
diff --git a/README b/README
index 7b642da..0eec502 100644 (file)
--- a/README
+++ b/README
@@ -12,9 +12,12 @@ with contributions from:
 
 Martijn Leisink
 Giuseppe Passino
 
 Martijn Leisink
 Giuseppe Passino
+Frederik Eaton
+Bastian Wemmenhove
 Christian Wojek
 Claudio Lima
 Christian Wojek
 Claudio Lima
-Bastian Wemmenhove
+Jiuxiang Hu
+Peter Gober
 
 
 ----------------------------------------------------------------------------------
 
 
 ----------------------------------------------------------------------------------
@@ -38,7 +41,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 SCIENTISTS: please be aware that the fact that this program is released as Free
 Software does not excuse you from scientific propriety, which obligates you to
 
 SCIENTISTS: please be aware that the fact that this program is released as Free
 Software does not excuse you from scientific propriety, which obligates you to
-give appropriate credit! If you write a scientific paper describing research
+give appropriate credit. If you write a scientific paper describing research
 that made substantive use of this program, it is your moral obligation as a
 scientist to (a) mention the fashion in which this software was used, including
 the version number, with a citation to the literature, to allow replication;
 that made substantive use of this program, it is your moral obligation as a
 scientist to (a) mention the fashion in which this software was used, including
 the version number, with a citation to the literature, to allow replication;
@@ -85,7 +88,8 @@ Currently, libDAI supports the following (approximate) inference methods:
     * Tree Expectation Propagation [MiQ04];
     * Generalized Belief Propagation [YFW05];
     * Double-loop GBP [HAK03];
     * Tree Expectation Propagation [MiQ04];
     * Generalized Belief Propagation [YFW05];
     * Double-loop GBP [HAK03];
-    * Various variants of Loop Corrected Belief Propagation [MoK07, MoR05].
+    * Various variants of Loop Corrected Belief Propagation [MoK07, MoR05];
+    * Gibbs sampler.
 
 
 Why C++?
 
 
 Why C++?
@@ -124,10 +128,10 @@ A description of the factor graph (.fg) file format can be found in the file FIL
 Compatibility
 -------------
 The code has been developed under Debian GNU/Linux with the GCC compiler suite.
 Compatibility
 -------------
 The code has been developed under Debian GNU/Linux with the GCC compiler suite.
-libDAI compiles successfully with g++ versions 4.1, 4.2 and 4.3.
+libDAI compiles successfully with g++ versions 3.4, 4.1, 4.2 and 4.3.
 
 libDAI has also been successfully compiled with MS Visual Studio 2008 under Windows
 
 libDAI has also been successfully compiled with MS Visual Studio 2008 under Windows
-(but not all build targets are supported yet).
+(but not all build targets are supported yet) and with Cygwin under Windows.
 
 
 Quick start (linux/cygwin)
 
 
 Quick start (linux/cygwin)
@@ -137,12 +141,20 @@ You need:
 - GNU make
 - doxygen
 - graphviz
 - GNU make
 - doxygen
 - graphviz
-- recent boost C++ libraries (at least version 1.34)
+- recent boost C++ libraries (at least version 1.34 or 1.37 for cygwin)
 
 On Debian/Ubuntu, you can easily install all these packages with a single command:
 "apt-get install g++ make doxygen libboost-dev libboost-graph-dev libboost-program-options-dev"
 (root permissions needed).
 
 
 On Debian/Ubuntu, you can easily install all these packages with a single command:
 "apt-get install g++ make doxygen libboost-dev libboost-graph-dev libboost-program-options-dev"
 (root permissions needed).
 
+On Cygwin, the prebuilt Cygwin package boost-1.33.1-x is known not to work.
+You can however obtain the latest boost version (you need at least 1.37.0)
+from http://www.boost.org/ and compile/install it with:
+
+  ./configure
+  make
+  make install
+
 To build the source, edit the Makefile and adapt it to your local setup. Then, run
     
     make
 To build the source, edit the Makefile and adapt it to your local setup. Then, run
     
     make
@@ -161,10 +173,13 @@ Quick start (windows)
 You need:
 - A recent version of MicroSoft Visual Studio (2008 works)
 - recent boost C++ libraries (version 1.34 or higher)
 You need:
 - A recent version of MicroSoft Visual Studio (2008 works)
 - recent boost C++ libraries (version 1.34 or higher)
+- GNU make (can be obtained from http://gnuwin32.sourceforge.net)
+For the regression test, you need:
+- GNU diff, GNU sed (can be obtained from http://gnuwin32.sourceforge.net)
 
 To build the source, edit the Makefile and adapt it to your local setup. Then, run (from the command line)
     
 
 To build the source, edit the Makefile and adapt it to your local setup. Then, run (from the command line)
     
-    nmake -f Makefile.win
+    make -f Makefile.win
 
 If the build was successful, you can test the example program:
 
 
 If the build was successful, you can test the example program: