mirror of
https://git.savannah.gnu.org/git/guile.git
synced 2025-05-20 11:40:18 +02:00
* README (Guile Documentation, About This Distribution): updated.
This commit is contained in:
parent
1a35eadceb
commit
ae8de16e0a
1 changed files with 49 additions and 30 deletions
79
README
79
README
|
@ -12,45 +12,73 @@ Please send bug reports to bug-guile@gnu.org.
|
|||
|
||||
Guile Documentation ==================================================
|
||||
|
||||
There is some preliminary documentation for Guile under the directory
|
||||
doc. The real Guile manual is incomplete, and is currently being
|
||||
revised. A development snapshot of the manual is available at
|
||||
ftp.red-bean.com as /pub/guile/snapshots/guile-doc-snap.tar.gz.
|
||||
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
|
||||
|
||||
There is a plan to distribute the reference manual with guile-core,
|
||||
with much of the text generated from the docstrings in the sources.
|
||||
The docstrings are likely to be more up-to-date than the reference
|
||||
manual at present (see libguile/guile-procedures.txt which is
|
||||
generated by the build process).
|
||||
|
||||
About This Distribution ==============================================
|
||||
|
||||
Interesting files include:
|
||||
|
||||
- INSTALL, which contains instructions on building and installing Guile.
|
||||
- NEWS, which describes user-visible changes since the last release of Guile.
|
||||
- COPYING, which describes the terms under which you may redistribute
|
||||
Guile, and explains that there is no warranty.
|
||||
|
||||
Building and installing this distribution gives you:
|
||||
guile --- a stand-alone interpreter for Guile, usually installed in
|
||||
/usr/local/bin. With no arguments, this is a simple
|
||||
interactive Scheme interpreter. It can also be used as an
|
||||
interpreter for script files; see the NEWS file for details.
|
||||
Files are usually installed according to the prefix specified to
|
||||
configure, /usr/local by default. Building and installing gives you:
|
||||
|
||||
Executables, in ${prefix}/bin:
|
||||
|
||||
guile --- a stand-alone interpreter for Guile. With no arguments, this
|
||||
is a simple interactive Scheme interpreter. It can also be used
|
||||
as an interpreter for script files; see the NEWS file for details.
|
||||
guile-config --- a Guile script which provides the information necessary
|
||||
to link your programs against the Guile library.
|
||||
guile-snarf --- a script to parse declarations in your C code for
|
||||
Scheme-visible C functions, Scheme objects to be used by C code, etc.
|
||||
Scheme-visible C functions, Scheme objects to be used by C code,
|
||||
etc.
|
||||
|
||||
Libraries, in ${prefix}/lib. Depending on the platform and options
|
||||
given to configure, you may get shared libraries in addition
|
||||
to or instead of these static libraries:
|
||||
|
||||
libguile.a --- an object library containing the Guile interpreter,
|
||||
usually installed in /usr/local/lib. You can use Guile in
|
||||
your own programs by linking against this.
|
||||
You can use Guile in your own programs by linking against this.
|
||||
libqthreads.a --- an object library containing the QuickThreads
|
||||
primitives. If you enabled thread support when you configured
|
||||
Guile, you will need to link your code against this too.
|
||||
libguilereadline.a --- an object library containing glue code for the
|
||||
GNU readline library. See NEWS for instructions on how to enable
|
||||
readline for your personal use.
|
||||
<libguile.h>, <guile/gh.h>, <libguile/*.h> --- header files for
|
||||
libguile.a, usually installed in /usr/local/include.
|
||||
ice-9, ice-9/*.scm --- run-time support for Guile: the module
|
||||
system, read-eval-print loop, some R4RS code and other
|
||||
infrastructure. Usually installed in
|
||||
/usr/local/share/guile/<version>.
|
||||
data-rep.info --- An essay on how to write C code that works with
|
||||
|
||||
Header files, in ${prefix}/include:
|
||||
|
||||
libguile.h, guile/gh.h, libguile/*.h --- for libguile.
|
||||
guile-readline/readline.h --- for guile-readline.
|
||||
|
||||
Support files, in ${prefix}/share/guile/<version>:
|
||||
|
||||
ice-9/* --- run-time support for Guile: the module system,
|
||||
read-eval-print loop, some R4RS code and other infrastructure.
|
||||
|
||||
Automake macros, in ${prefix}/share/aclocal:
|
||||
|
||||
guile.m4
|
||||
|
||||
Documentation in Info format, in ${prefix}/info:
|
||||
|
||||
data-rep.info --- an essay on how to write C code that works with
|
||||
Guile Scheme values.
|
||||
|
||||
The Guile source tree is laid out as follows:
|
||||
|
@ -70,14 +98,7 @@ guile-readline:
|
|||
The glue code for using GNU readline with Guile. This
|
||||
will be build when configure can find a recent enough readline
|
||||
library on your system.
|
||||
doc: Some preliminary documentation for Guile. The real Guile
|
||||
manual is incomplete, and is currently being revised.
|
||||
A development snapshot of the manual is available at
|
||||
ftp.red-bean.com as /pub/guile/snapshots/guile-doc-snap.tar.gz.
|
||||
doc/example-smob: Sample code, discussed in the preliminary
|
||||
documentation above, for a program that extends Guile with a
|
||||
new data type, and functions that operate on it.
|
||||
|
||||
doc: Documentation (see above).
|
||||
|
||||
Anonymous CVS Access and FTP snapshots ===============================
|
||||
|
||||
|
@ -99,10 +120,8 @@ guile-cvs-subscribe-foo=bar.com@sourceware.cygnus.com.
|
|||
Obtaining Guile ======================================================
|
||||
|
||||
The latest official Guile release is available via anonymous FTP from
|
||||
ftp.gnu.org, as /pub/gnu/guile/guile-1.3.4.tar.gz.
|
||||
|
||||
Via the web, that's: ftp://ftp.gnu.org/pub/gnu/guile/guile-1.3.4.tar.gz
|
||||
For getit, that's: ftp.gnu.org:/pub/gnu/guile/guile-1.3.4.tar.gz
|
||||
ftp://ftp.gnu.org/pub/gnu/guile/guile-1.3.4.tar.gz
|
||||
|
||||
The mailing list `guile@sourceware.cygnus.com' carries discussions,
|
||||
questions, and often answers, about Guile. To subscribe, send mail to
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue