README
1
2 SKETCHY LISP
3
4
5 1) About
6
7 | SketchyLISP
8 | An interpreter for purely applicative Scheme
9 |
10 | Copyright (C) 2005,2006,2007 Nils M Holm. All rights reserved.
11 |
12 | See the file LICENSE for conditions of use.
13 |
14 | The official SketchyLISP web page is at:
15 | http://www.t3x.org/sketchy/
16
17
18 2) Latest News
19
20 Added immutable vectors.
21
22 Added Cygwin Makefile and sketchy.bat.
23
24 Dropped CALL/CC. It is an interesting proof of concept, but of
25 little real use in a purely functional interpreter.
26
27
28 3) What is SketchyLISP?
29
30 SketchyLISP is an embeddable interpreter for a purely
31 applicative dialect of Scheme. It may be considered an
32 implementation of pure LISP plus global definitions and
33 some input/output functions.
34
35
36 4) Supported Systems and Installation
37
38
39 4.1 Supported Platforms
40
41 The SketchyLISP core is written in pure ANSI C and hence
42 compiles on any system providing an ANSI C (C89) compiler.
43
44
45 4.2 Unix Installation
46
47 If you are running FreeBSD, NetBSD, or Linux, you may use the
48 supplied Makefile without modification:
49
50 | make
51 | make install # root permissions required
52
53 In case sketchy cannot find its shared library, you may have to
54 run ldconfig(8) on /usr/local/lib (as root).
55
56 If everything else fails, install sketchy-static instead.
57
58
59 4.3 Cygwin Installation
60
61 Just use the supplied Cygwin Makefile:
62
63 | make -f Makefile.CYGWIN install
64
65 You might have to add /usr/local/man to your MANPATH.
66
67 You can use the batch file util/sketchy.bat to run SketchyLISP
68 directly from the W*ndows desktop. Just place the file in a
69 directory containing SKETCHY.EXE and the lib/, ext/, and src/
70 subdirectories. Then edit the line containing
71
72 | set PATH=%PATH%;C:\CYGWIN\BIN
73
74 to include the directory holding the CYGWIN1.DLL file on your
75 computer.
76
77 CYGWIN1.DLL is part of Cygwin. It is not included in the
78 SketchyLISP distribution, because it is licensed under the GPL,
79 and I suspect that its source code is much larger than the
80 SketchyLISP source code itself.
81
82
83 4.4 Installation on other Systems
84
85 If you plan to install SketchyLISP on systems that are not
86 discussed here, you are currently on your own. That being said,
87 the interpreter compiles fine using MinGW, Turbo C, and the
88 Plan 9 ANSI/POSIX Environment (APE).
89
90
91 4.5 Testing
92
93 To test the interpreter, run
94
95 | make test
96
97 and/or
98
99 | util/examine
100
101 Note: On Cygwin util/examine will take some time.
102
103
104 4.6 Configuration
105
106 Finally, you should set the SKETCHYSRC environment variable to
107 a colon-separated list of directories that contain packages and
108 other frequently-used sources:
109
110 | SKETCHYSRC=/usr/local/share/sketchy/ext:/usr/local/share/sketchy/src
111 | export SKETCHYSRC
112
113
114 5) Getting Started
115
116 After installing SketchyLISP, the interpreter is started by
117 typing
118
119 | sketchy
120
121 To get a list of meta commands (while running sketchy), type
122 ':help'.
123
124 Typing
125
126 | man sketchy
127
128 at the Unix shell prompt will print the sketchy(1) man page.
129
130 The location of the SketchyLISP reference manual depends on
131 your environment. By default, documentation is located here:
132
133 | /usr/local/share/doc/sketchy/index.html
134
135 Example programs can be found here:
136
137 | /usr/local/share/sketchy/src
138
139 The library source code is here:
140
141 | /usr/local/share/sketchy/lib
142 | /usr/local/share/sketchy/ext
143
144
145 6) Bugs
146
147 There certainly are some.
148
149
150 7) Contact
151
152 Send your feedback to Nils M Holm <nmh@t3x.org>.
153
154 If you want to support the author of SketchyLISP, consider
155 buying a copy of
156
157 "Sketchy LISP" (or another book of the same author) at
158
159 | http://www.lulu.com/content/213736
160
161 Thanks!
162
163