================================================================================
Quick Install

- 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 ]

================================================================================
Install

  [ 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:

Run minisat with same heuristics as version 2.0:

> minisat <cnf-file> -no-luby -rinc=1.5 -phase-saving=0 -rnd-freq=0.02

================================================================================
macOS static builds

- The Apple toolchains do not ship a static C runtime, so building a "mostly
  static" binary requires an alternate toolchain.  This repository provides a
  CMake toolchain file that drives Zig's cross compiler to produce macOS
  binaries with all Minisat components and third-party libraries linked
  statically while still depending on Apple's `libSystem` at runtime.

- Install [Zig](https://ziglang.org/) 0.12 or newer and configure the build
  using the provided toolchain:

  > cmake -S . -B build-macos \
          -DCMAKE_TOOLCHAIN_FILE=cmake/toolchains/zig-macos-static.cmake \
          -DSTATICCOMPILE=ON
  > cmake --build build-macos

- A reproducible environment is also available through Docker:

  > docker build -f docker/macos-static.Dockerfile -t minisat-macos-static .

  The resulting image contains the cross-compiled macOS binaries under
  `/src/build-macos`.