README docs update

* README docs update
@ 2003-06-05  1:20 Kevin Ryde
  2003-06-18 22:26 ` Marius Vollmer
  0 siblings, 1 reply; 2+ messages in thread
From: Kevin Ryde @ 2003-06-05  1:20 UTC (permalink / raw)


[-- Attachment #1: Type: text/plain, Size: 189 bytes --]

A possible update for the README, assuming this is all true.

	* README (Guile Documentation): Update to manuals now available,
	remove notes about the reference manual being in progress.


[-- Attachment #2: README.docs.diff --]
[-- Type: text/plain, Size: 1765 bytes --]

--- README.~1.92.~	2003-05-19 07:57:57.000000000 +1000
+++ README	2003-06-05 11:19:42.000000000 +1000
@@ -294,21 +294,20 @@
 
 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 the 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
 

[-- Attachment #3: Type: text/plain, Size: 142 bytes --]

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

^ permalink raw reply	[flat|nested] 2+ messages in thread