README

   1 Compiling
   2 ---------
   3
   4 Sawsim is written in noweb_ (`noweb` in Debian-based distributions).
   5 Extract Makefile and compile with:
   6
   7   $ notangle -Rmakefile src/sawsim.nw | sed 's/        /\t/' > Makefile
   8   $ make
   9
  10 Run the unit tests with:
  11
  12   $ make check
  13
  14 .. _noweb: http://www.eecs.harvard.edu/~nr/noweb/
  15
  16
  17 Dependencies
  18 ------------
  19
  20 Sawsim depends on the GSL_ (GNU Scientific Library) development
  21 package (`libgsl0-dev` in Debian-based distributions).
  22
  23 The unit test programs `check_*` depend on the check_ package (`check`
  24 in Debian-based distributions).
  25
  26 .. _GSL: http://www.gnu.org/software/gsl/
  27 .. _check: http://check.sourceforge.net/
  28
  29
  30 Python wrapper
  31 --------------
  32
  33 The `sawsim` binary only runs a single pull, but you'll probably want
  34 to run many repetitions to generate enough data for significant
  35 statistical analysis.  To facilitate this, we provide the `pysawsim`
  36 module which provides a higher level interface to `sawsim`.
  37
  38
  39 License
  40 -------
  41
  42 Saswim is released under the GNU GPLv3+.  See `COPYING` for details.