doc/README.txt

   1 I. Getting Started
   2
   3 To run SATCheck, you need to have built a SAT Solver from SATlib.  To
   4 obtain SATlib (from within the SATCheck directory):
   5
   6 git clone git://plrg.eecs.uci.edu/satlib.git
   7
   8 Then build a SAT solver in the SATlib distribution.  For example:
   9
  10 cd satlib/glucose-syrup/incremental
  11 make
  12 cp glucose ../../../sat_solver
  13
  14 Then you can build SATCheck.  Simply type make from within the main
  15 SATCheck directory.
  16
  17 One might find the options in config.h useful.
  18
  19
  20 II. Printing Event Graphs
  21
  22 Uncomment DUMP_EVENT_GRAPHS in config.h
  23
  24 Make clean and the remake the system.
  25
  26 Run the model checker.
  27
  28 Use dot (from graphviz) to convert the outputted dot files into the
  29 format of your choice.
  30
  31 III. Using the debugger (gdb).
  32
  33 You can launch the debugger by passing in the gdb option to run.sh (or
  34 you can lok at run.sh to see how to launch the model checker from
  35 within a debugger).  Since we trap SIGSEGV to detect pages that we
  36 need to update, you have to disable stopping on SIGSEGV.  To do this,
  37 use the following commands:
  38
  39 To run inside MacOS under gdb you need (lldb won't work as far as I know):
  40 set dont-handle-bad-access 1 (sometime not necessary)
  41 handle SIGBUS nostop noprint
  42
  43 To run in Linux under gdb, use:
  44 handle SIGSEGV nostop noprint
  45
  46 IV. Generating doxygen docs
  47
  48 Type "make docs".
  49 Then look in doc/docs/.