[mlpack-svn] r10894 - in mlpack/tags/mlpack-1.0.0: . doc/guide

[fastlab-svn at coffeetalk-1.cc.gatech.edu]

Author: rcurtin
Date: 2011-12-17 04:26:25 -0500 (Sat, 17 Dec 2011)
New Revision: 10894

Added:
   mlpack/tags/mlpack-1.0.0/README.txt
Modified:
   mlpack/tags/mlpack-1.0.0/CMakeLists.txt
   mlpack/tags/mlpack-1.0.0/doc/guide/build.hpp
Log:
Copmile in release mode.  Update documentation to say that.


Modified: mlpack/tags/mlpack-1.0.0/CMakeLists.txt
===================================================================
--- mlpack/tags/mlpack-1.0.0/CMakeLists.txt	2011-12-17 09:02:47 UTC (rev 10893)
+++ mlpack/tags/mlpack-1.0.0/CMakeLists.txt	2011-12-17 09:26:25 UTC (rev 10894)
@@ -52,8 +52,8 @@
 option(WITH_OPTIMIZERS "Include optimization code." OFF)
 
 # Default to debugging mode for developers.
-option(DEBUG "Compile with debugging information" ON)
-option(PROFILE "Compile with profiling information" ON)
+option(DEBUG "Compile with debugging information" OFF)
+option(PROFILE "Compile with profiling information" OFF)
 option(ARMA_EXTRA_DEBUG "Compile with extra Armadillo debugging symbols." OFF)
 
 # This is as of yet unused.

Added: mlpack/tags/mlpack-1.0.0/README.txt
===================================================================
--- mlpack/tags/mlpack-1.0.0/README.txt	                        (rev 0)
+++ mlpack/tags/mlpack-1.0.0/README.txt	2011-12-17 09:26:25 UTC (rev 10894)
@@ -0,0 +1,16 @@
+Far more extensive documentation available at
+  http://www.mlpack.org/
+
+To build, use CMake:
+
+$ mkdir build
+$ cd build
+$ cmake ../
+$ make
+$ sudo make install
+
+If you are suffering segfault, recompile with debugging information:
+
+$ cmake -DDEBUG=ON ../
+
+and you will likely get a listed error as opposed to just a segfault.

Modified: mlpack/tags/mlpack-1.0.0/doc/guide/build.hpp
===================================================================
--- mlpack/tags/mlpack-1.0.0/doc/guide/build.hpp	2011-12-17 09:02:47 UTC (rev 10893)
+++ mlpack/tags/mlpack-1.0.0/doc/guide/build.hpp	2011-12-17 09:26:25 UTC (rev 10894)
@@ -51,8 +51,8 @@
 
 The full list of options MLPACK allows:
 
- - DEBUG=(ON/OFF): compile with debugging symbols (default ON)
- - PROFILE=(ON/OFF): compile with profiling symbols (default ON)
+ - DEBUG=(ON/OFF): compile with debugging symbols (default OFF)
+ - PROFILE=(ON/OFF): compile with profiling symbols (default OFF)
  - ARMA_EXTRA_DEBUG=(ON/OFF): compile with extra Armadillo debugging symbols
        (default OFF)