1This is file /usr/cvw/ideal/README.
2
3The makefile in this directory assumes that all necessary
4C programs reside in the directory along with it.
5
6You'll need to change LIBDIR in the makefile to reflect where ideal's
7library will live.
8
9The only explicit call to the memory allocator is
10in a macro tryalloc() defined in malloc.c.
11The only explicit call to the memory free routine
12is in a macro tryfree() defined in ideal.h.
13You may need to use a garbage-collecting
14allocator if your machine is small.
15You'll notice that macro tryalloc also includes a loop
16to clear the allocated node--if you want, get rid of the
17loop, and call calloc;
18be sure, though, to call calloc with TWO arguments,
19the first being the number of nodes wanted (1).
20
21Because of uucp difficulties,
22there is a large file--subdirs.cpio--
23created with the command cpio -o <subdirectories >subdirs.cpio
24You can get them out with cpio -ir <subdirs.cpio
25
26The lib subdirectory of this directory should contain
27the library files you'll need--arcs, circles, etc.
28
29The tests subdirectory should contain some tests that
30exercise the code quite thoroughly.
31The exercise is: cd tests; regress; clean
32
33The idfilt subdirectory includes filters for raw
34ideal output to troff, plot, and tektronix terminals.
35You'll need to get into that subdirectory to make the
36filters (4filt for 4014s, pfilt for general plot,
37tfilt for Brian Kernighan's troff to drive the Linotron 202).
38
39The shell command that invokes the ideal processor
40with the correct postprocessor according to the
41flags described in manpage is in ideal.cmd.
42
43The following ideal documentation exists:
44	my dissertation
45	my sigplan conference paper
46	my TOG paper
47	a user manual
48