[bpt/guile.git] / doc / README

This directory contains documentation on the Guile core.         -*-text-*-

The documentation consists of the following manuals.

- The Guile Tutorial (guile-tut.texi) contains a tutorial introduction
  to using Guile.

- The Guile Reference Manual (guile.texi) contains (or is intended to
  contain) reference documentation on all aspects of Guile.

- The Revised^5 Report on the Algorithmic Language Scheme (r5rs.texi).

Please be aware that this is all very much work in progress (apart
from the Revised^5 Report).  Bug reports and contributions are
welcome!

The file `oldfmt.c' contains a function which can be used by
application writers to support both old-style and new-style error
format strings.

The `sources' directory includes some stuff relevant to the Guile
reference manual, and which may eventually be folded in to it.  It's
not immediately relevant, however, which is why it's not in this
directory.

The Revised^4 Report (r4rs.texi) is no longer in this distribution, as
it is completely superseded by the Revised^5 Report.  If you need to
consult R4RS, it is still widely available, for example at
http://www-swiss.ai.mit.edu/projects/info/SchemeDocs/r4rs/.
Commit	Line	Data
c2dc2842	1	This directory contains documentation on the Guile core. --text--
21b4d3c2	2
c2dc2842 NJ	3	The documentation consists of the following manuals.
	4
	5	- The Guile Tutorial (guile-tut.texi) contains a tutorial introduction
	6	to using Guile.
	7
	8	- The Guile Reference Manual (guile.texi) contains (or is intended to
	9	contain) reference documentation on all aspects of Guile.
	10
b9bf148f	11	- The Revised^5 Report on the Algorithmic Language Scheme (r5rs.texi).
c2dc2842 NJ	12
c2dc2842 NJ	13	Please be aware that this is all very much work in progress (apart
b9bf148f	14	from the Revised^5 Report). Bug reports and contributions are
c2dc2842	15	welcome!
49395101 MD	16
	17	The file `oldfmt.c' contains a function which can be used by
	18	application writers to support both old-style and new-style error
	19	format strings.
14dd0e27	20
c2dc2842 NJ	21	The `sources' directory includes some stuff relevant to the Guile
	22	reference manual, and which may eventually be folded in to it. It's
	23	not immediately relevant, however, which is why it's not in this
	24	directory.
b9bf148f NJ	25
	26	The Revised^4 Report (r4rs.texi) is no longer in this distribution, as
	27	it is completely superseded by the Revised^5 Report. If you need to
	28	consult R4RS, it is still widely available, for example at
	29	http://www-swiss.ai.mit.edu/projects/info/SchemeDocs/r4rs/.