From eadc3ef0955432023f72a4a52af5069b4a114ecc Mon Sep 17 00:00:00 2001
From: Niklas Sorensson <niklasso@gmail.com>
Date: Tue, 11 Jan 2011 16:17:25 +0100
Subject: [PATCH] Updated README file with some instructions on
 configure/build/install.

---
 README | 60 +++++++++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 47 insertions(+), 13 deletions(-)

diff --git a/README b/README
index e5e5617..f379108 100644
--- a/README
+++ b/README
@@ -1,23 +1,57 @@
 ================================================================================
-DIRECTORY OVERVIEW:
+Quick Install
 
-mtl/            Mini Template Library
-utils/          Generic helper code (I/O, Parsing, CPU-time, etc)
-core/           A core version of the solver
-simp/           An extended solver with simplification capabilities
-README
-LICENSE
+- Decide where to install the files . The simplest approach is to use
+  GNU standard locations and just set a "prefix" for the root install
+  directory (reffered to as $PREFIX below). More control can be
+  achieved by overriding other of the GNU standard install locations
+  (includedir, bindir, etc). Configuring with just a prefix:
+
+  > make config prefix=$PREFIX
+
+- Compiling and installing:
+
+  > make install
+
+================================================================================
+Configuration
+
+- Multiple configuration steps can be joined into one call to "make
+  config" by appending multiple variable assignments on the same line.
+
+- The configuration is stored in the file "config.mk". Look here if
+  you want to know what the current configuration looks like.
+
+- To reset from defaults simply remove the "config.mk" file or call
+  "make distclean".
+
+- Recompilation can be done without the configuration step.
+
+  [ TODO: describe configartion possibilities for compile flags / modes ]
+
+================================================================================
+Building
+
+  [ TODO: describe seperate build modes ]
 
 ================================================================================
-BUILDING: (release version: without assertions, statically linked, etc)
+Install
 
-export MROOT=<minisat-dir>              (or setenv in cshell)
-cd { core | simp }
-gmake rs
-cp minisat_static <install-dir>/minisat
+  [ TODO: ? ]
+
+================================================================================
+Directory Overview:
+
+minisat/mtl/            Mini Template Library
+minisat/utils/          Generic helper code (I/O, Parsing, CPU-time, etc)
+minisat/core/           A core version of the solver
+minisat/simp/           An extended solver with simplification capabilities
+doc/                    Documentation
+README
+LICENSE
 
 ================================================================================
-EXAMPLES:
+Examples:
 
 Run minisat with same heuristics as version 2.0: