Remove execute permission from pysawsim/manager/pbs.py.

[sawsim.git] / README

diff --git a/README b/README
index 57aa9746e9cad08d05271e7d583f91ecbe0fa468..46340b8a4f398245d0efb77e446816943a1485ca 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,42 @@
-Warning: also my noweb-training program.
- http://www.eecs.harvard.edu/~nr/noweb/
-(noweb, or the transitional nowebm, in Debian-based distributions)
+Compiling
+---------
 
+Sawsim is written in noweb_ (`noweb` in Debian-based distributions).
 Extract Makefile and compile with:
- $ notangle -Rmakefile sawsim.nw | sed 's/        /\t/' > Makefile
- $ make
-Run the unit tests with
- $ make check
-
-Depends on the GSL (GNU Scientific Library) development package.
- http://www.gnu.org/software/gsl/
-(libgsl0-dev in Debian-based distributions)
+
+  $ notangle -Rmakefile src/sawsim.nw | sed 's/        /\t/' > Makefile
+  $ make
+
+Run the unit tests with:
+
+  $ make check
+
+.. _noweb: http://www.eecs.harvard.edu/~nr/noweb/
+
+
+Dependencies
+------------
+
+Sawsim depends on the GSL_ (GNU Scientific Library) development
+package (`libgsl0-dev` in Debian-based distributions).
+
+The unit test programs `check_*` depend on the check_ package (`check`
+in Debian-based distributions).
+
+.. _GSL: http://www.gnu.org/software/gsl/
+.. _check: http://check.sourceforge.net/
+
+
+Python wrapper
+--------------
+
+The `sawsim` binary only runs a single pull, but you'll probably want
+to run many repetitions to generate enough data for significant
+statistical analysis.  To facilitate this, we provide the `pysawsim`
+module which provides a higher level interface to `sawsim`.
+
+
+License
+-------
+
+Saswim is released under the GNU GPLv3+.  See `COPYING` for details.