-This directory contains documentation on the Guile core.
-
-At the moment, we don't have a full manual on Guile; that's at the
-head of our task list.
-
-The file `data-rep.texi' is an essay on how to write C code that uses
-Guile values. If you're interested in writing a application which is
-extensible via Guile, this is a good place to start. Make builds the
-`info' manual by default, designed to be read on-line; if you want to
-print it out, go to the `doc' subdirectory of the tree you're building
-in, and run `make data-rep.ps'.
-
-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.
+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 `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/.
HCoop / bpt / guile.git / blobdiff