summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorKevin Ryde <user42@zip.com.au>2003-06-18 23:37:02 +0000
committerKevin Ryde <user42@zip.com.au>2003-06-18 23:37:02 +0000
commitea8ac9ace0432cdca33d4d3b980c2a268b776bb1 (patch)
treeff574728c12478545c41113d8d772a8a3c6984c4 /README
parentfbaca220b5274911a8cd768cb97c51f3614087f6 (diff)
(Guile Documentation): Update to manuals now available,
remove notes about the reference manual being in progress.
Diffstat (limited to 'README')
-rw-r--r--README29
1 files changed, 14 insertions, 15 deletions
diff --git a/README b/README
index a438859fe..b6c337a92 100644
--- a/README
+++ b/README
@@ -294,21 +294,20 @@ Example:
Guile Documentation ==================================================
-The doc directory contains a few articles on specific topics and some
-examples, including data-rep.texi which describes the internal
-representation of data types in Guile. The example-smob directory
-contains example source code for the "Defining New Types (Smobs)" chapter.
-
-The incomplete Guile reference manual is available at
-
- ftp://ftp.red-bean.com/pub/guile/snapshots/guile-doc-snap.tar.gz
-
-Neil Jerram is working on the new reference manual, which will be
-distributed with guile-core. The new manual will be synchronized with
-the docstrings in the sources. Until then, please be aware that the
-docstrings are likely to be more up-to-date than the old reference
-manual (use `(help)' or see libguile/guile-procedures.txt which is
-generated by the build process).
+If you've never used Scheme before, then the Guile Tutorial
+(guile-tut.info) is a good starting point. The Guile Reference Manual
+(guile.info) is the primary documentation for Guile. The Goops object
+system is documented separately (goops.info). A copy of the R5RS
+Scheme specification is included too (r5rs.info).
+
+Info format versions of this documentation are installed as part of
+the normal build process. The texinfo sources are under the doc
+directory, and other formats like Postscript, PDF, DVI or HTML can be
+generated from them with Tex and Texinfo tools.
+
+The doc directory also includes an example-smob subdirectory which has
+the example code from the "Defining New Types (Smobs)" chapter of the
+reference manual.
The Guile WWW page is at