/**********************************************************/
 * 
 *   ReadMe file for the SnapPea kernel
 *
/**********************************************************/

The SnapPea kernel is a pure-C library written by Jeff Weeks
<http://geometrygames.org> for studying hyperbolic structures on
3-manifolds.  It is maintained by Jeff Weeks and Nathan Dunfield
<http://dunfield.info>.  Comments and questions should be directed to
both Jeff and Nathan.

The SnapPeaKernel is distributed under the terms of the GNU General
Public License, version 2 or any later version, as published by the
Free Software Foundation.  See GPL.txt.  

Virtually all of the kernel documentation is contained
in the source code itself.  If you're not sure where
to begin, you should

(0)	Try out one of the programs based on this library, e.g. the 
	original SnapPea for Classic Mac OS, or the modern SnapPy.

(1)	Read SnapPea.h	 This is technically not part of the
	kernel, but rather the protocol for how the kernel
	and the UI should communicate.

(2)	Read triangulation.h.  It describes the data structure
	which SnapPea uses to pass manifolds from one module
	to another.

(3)	Read the source code in the files of greatest interest
	to you.  Triangulation.h makes extensive references
	to what is found where in the remaining code.

Please see detab.c for information on getting the tab
stops to look right on a unix machine.

To see the history of development of the kernel post 2009/8, install
Mercurial <http://www.selenic.com/mercurial>, do "hg serve" in the
SnapPeaKernel directory and point your webbrowser to
<http://localhost:8000>.  
