Skip to content

Commit eadc3ef

Browse files
committed
Updated README file with some instructions on configure/build/install.
1 parent 6736d2f commit eadc3ef

File tree

1 file changed

+47
-13
lines changed

1 file changed

+47
-13
lines changed

README

+47-13
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,57 @@
11
================================================================================
2-
DIRECTORY OVERVIEW:
2+
Quick Install
33

4-
mtl/ Mini Template Library
5-
utils/ Generic helper code (I/O, Parsing, CPU-time, etc)
6-
core/ A core version of the solver
7-
simp/ An extended solver with simplification capabilities
8-
README
9-
LICENSE
4+
- Decide where to install the files . The simplest approach is to use
5+
GNU standard locations and just set a "prefix" for the root install
6+
directory (reffered to as $PREFIX below). More control can be
7+
achieved by overriding other of the GNU standard install locations
8+
(includedir, bindir, etc). Configuring with just a prefix:
9+
10+
> make config prefix=$PREFIX
11+
12+
- Compiling and installing:
13+
14+
> make install
15+
16+
================================================================================
17+
Configuration
18+
19+
- Multiple configuration steps can be joined into one call to "make
20+
config" by appending multiple variable assignments on the same line.
21+
22+
- The configuration is stored in the file "config.mk". Look here if
23+
you want to know what the current configuration looks like.
24+
25+
- To reset from defaults simply remove the "config.mk" file or call
26+
"make distclean".
27+
28+
- Recompilation can be done without the configuration step.
29+
30+
[ TODO: describe configartion possibilities for compile flags / modes ]
31+
32+
================================================================================
33+
Building
34+
35+
[ TODO: describe seperate build modes ]
1036

1137
================================================================================
12-
BUILDING: (release version: without assertions, statically linked, etc)
38+
Install
1339

14-
export MROOT=<minisat-dir> (or setenv in cshell)
15-
cd { core | simp }
16-
gmake rs
17-
cp minisat_static <install-dir>/minisat
40+
[ TODO: ? ]
41+
42+
================================================================================
43+
Directory Overview:
44+
45+
minisat/mtl/ Mini Template Library
46+
minisat/utils/ Generic helper code (I/O, Parsing, CPU-time, etc)
47+
minisat/core/ A core version of the solver
48+
minisat/simp/ An extended solver with simplification capabilities
49+
doc/ Documentation
50+
README
51+
LICENSE
1852

1953
================================================================================
20-
EXAMPLES:
54+
Examples:
2155

2256
Run minisat with same heuristics as version 2.0:
2357

0 commit comments

Comments
 (0)