Move doc files into guile-core distribution (6)
[bpt/guile.git] / doc / README
1 This directory contains documentation on the Guile core. -*-text-*-
2
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
11 - The GOOPS Manual (goops.texi) contains both tutorial-style and
12 reference documentation for using GOOPS, Guile's Object Oriented
13 Programming System.
14
15 - The Revised^4 and Revised^5 Reports on the Algorithmic Language
16 Scheme (r4rs.texi and r5rs.texi).
17
18 Please be aware that this is all very much work in progress (apart
19 from the Revised Reports). Bug reports and contributions are
20 welcome!
21
22 The file `oldfmt.c' contains a function which can be used by
23 application writers to support both old-style and new-style error
24 format strings.
25
26 The `sources' directory includes some stuff relevant to the Guile
27 reference manual, and which may eventually be folded in to it. It's
28 not immediately relevant, however, which is why it's not in this
29 directory.