Difference between revisions of "Documentation"
From Gambit wiki
(→More) |
|||
Line 6: | Line 6: | ||
See the [[Scheme]] page for documentation on Scheme in general. | See the [[Scheme]] page for documentation on Scheme in general. | ||
− | == | + | == Prebuilt Distributions == |
Some prebuilt distributions are [[Distributions | available]]. | Some prebuilt distributions are [[Distributions | available]]. | ||
== Building Gambit from Source == | == Building Gambit from Source == | ||
− | |||
− | |||
To build Gambit from source, one must first run the configure script, which has a number | To build Gambit from source, one must first run the configure script, which has a number | ||
Line 50: | Line 48: | ||
the Termite source code has been distributed with Gambit, so we point to the Termite web site | the Termite source code has been distributed with Gambit, so we point to the Termite web site | ||
from here. | from here. | ||
+ | |||
+ | == Tutorials == | ||
+ | [[A Tour of Scheme in Gambit]] gives a general introduction to Scheme and Gambit to people with experiences of general programming languages. Available in [media:A_Tour_of_Scheme_in_Gambit.pdf|PDF], [media:A_Tour_of_Scheme_in_Gambit.odf|Open Office] and [media:A_Tour_of_Scheme_in_Gambit.doc|Microsoft Word] formats. | ||
== Internals Documentation == | == Internals Documentation == |
Revision as of 19:48, 8 January 2009
User Documentation
There is a user manual for Gambit in HTML and PDF formats.
See the Scheme page for documentation on Scheme in general.
Prebuilt Distributions
Some prebuilt distributions are available.
Building Gambit from Source
To build Gambit from source, one must first run the configure script, which has a number of important options.
There are various make targets of which you should be aware.
Packages
Snow is a package system for R4RS and R5RS Scheme. Nearly all Snow packages run on Gambit. Users can simply download and install existing packages. For those who want to develop new packages, Snow has its own documentation.
Libraries
The Scheme community has accumulated a set of common libraries and conventions called Scheme Requests for Implementation. For Gambit's built-in support and further links, see the SRFI:s page.
There is an informal listing of sourcecode on the Dumping Grounds.
Editor/IDE Support
Gambit provides a powerful development environment through Emacs.
For those running Windows you can download Emacs here. You may want to read the Emacs FAQ for Windows before customizing Emacs for use with Gambit.
Alternatively, you may be interested in editors such as Eclipse with the SchemeWay extension, or just about any text editor with Scheme syntax highlighting, such as VIM or GVIM.
Termite
Termite is an Erlang-like distributed programming system written in Scheme.
Distributed computing hot right now, and Termite has been noticed in blogs and elsewhere.
Termite depends on specific features of Gambit, and at one time or another the Termite source code has been distributed with Gambit, so we point to the Termite web site from here.
Tutorials
A Tour of Scheme in Gambit gives a general introduction to Scheme and Gambit to people with experiences of general programming languages. Available in [media:A_Tour_of_Scheme_in_Gambit.pdf|PDF], [media:A_Tour_of_Scheme_in_Gambit.odf|Open Office] and [media:A_Tour_of_Scheme_in_Gambit.doc|Microsoft Word] formats.
Internals Documentation
People who want to contribute to Gambit development will need to learn something about how the Gambit-C runtime and compiler are organized. While we intend that source code documentation be included in the source itself (currently there is very little documentation), we intend that descriptions of program design or algorithms used in the runtime and compiler could be included on the Internal Documentation page.
Working with External Libraries
With Gambit's C FFI (Foreign Function Interface), one can easily use standard C and C++ libraries with your code; this wiki has some examples of and practices on using Gambit with external libraries. See Using Gambit with External Libraries.
Debugging
See the Debugging page.
More
The mailing list archive covers many topics at depth. You can make Google search queries limited to the mailing list by clicking "advanced settings" on www.google.com.