[bpt/guile.git] / examples / README

							       -*- outline -*-

* Overview

This directory contains examples illustrating various aspects of Guile
programming.

If you plan writing Scheme programs, have a look at the `scripts'
directory.  To learn more about Guile modules, check out the `modules'
directory, and maybe the `box-module' and `box-dynamic-module'
directories, if you are into C programming or shared libraries,
respectively.  The `safe' directory contains examples for evaluation
Scheme code in controlled environments (sandboxing).  The directories
`box', `box-module', `box-dynamic' and `box-dynamic-module' are
interesting if you plan writing Guile extensions.

See the README files in the subdirectories for details.


* Included Examples

scripts             Examples for writing simple scripts in Guile Scheme.

box		    Example for extending Guile with a new data type.

box-module	    Similar to `box', but defines new procedures in a
		    named module.
box-dynamic	    Implements the box type in a dynamically loadable
		    library.
box-dynamic-module  Combination of `box-module' and `box-dynamic': 
		    Implements the `box' type in a shared library and
		    defines the procedures in a Guile module.

modules		    Examples for writing and using Guile modules.

safe		    Examples for creating and using safe environments.
Commit	Line	Data
673509f8 MG	1	-- outline --
	2
	3	* Overview
2de7ddb7	4
cc6dd1c5	5	This directory contains examples illustrating various aspects of Guile
2de7ddb7 MG	6	programming.
2de7ddb7 MG	7
673509f8 MG	8	If you plan writing Scheme programs, have a look at the `scripts'
	9	directory. To learn more about Guile modules, check out the `modules'
	10	directory, and maybe the `box-module' and `box-dynamic-module'
	11	directories, if you are into C programming or shared libraries,
	12	respectively. The `safe' directory contains examples for evaluation
	13	Scheme code in controlled environments (sandboxing). The directories
	14	`box', `box-module', `box-dynamic' and `box-dynamic-module' are
	15	interesting if you plan writing Guile extensions.
	16
2de7ddb7 MG	17	See the README files in the subdirectories for details.
2de7ddb7 MG	18
673509f8 MG	19
	20	* Included Examples
	21
8779d595	22	scripts Examples for writing simple scripts in Guile Scheme.
673509f8	23
8779d595	24	box Example for extending Guile with a new data type.
673509f8	25
8779d595 MG	26	box-module Similar to `box', but defines new procedures in a
	27	named module.
	28	box-dynamic Implements the box type in a dynamically loadable
	29	library.
	30	box-dynamic-module Combination of `box-module' and `box-dynamic':
	31	Implements the `box' type in a shared library and
	32	defines the procedures in a Guile module.
673509f8	33
8779d595	34	modules Examples for writing and using Guile modules.
8779d595	35
673509f8	36	safe Examples for creating and using safe environments.