CDL3 README

USAGE 

After installing the compiler (see the INSTALL file), you can use it
to compile .k3 files:

    cdlc -L /path/to/cdl3/include/ main.k3

This will compile main.k3 into main.o.  Note the final slash in cdlc's 
library include path.

Then link the .o files together with the CDL3 runtime library, into
an executable:

    gcc -L /path/to/cdl3/lib -o myapp main.o ... -lcdlrts 

The CDL3 distribution includes a simple 'Hello World' example showing
you how to set up a Makefile to automate these tasks. Note that this
example Makefile (like the manpages) are generated to use the paths
for which the CDL3 compiler is configured.

DOCUMENTATION 

Refer to the cdlc(1) man page for more information about invoking the
CDL3 compiler.

There are several other man pages which document the CDL3 language.
You may want to have a look at cdlrts(3) which gives an overview and
pointers to the other man pages.

The CDL3 language is documented extensively in a 100+ page manual 
in PostScript format, which comes with the distribution. 

More information on CDL3 at http://www.cs.ru.nl/cdl3/.

COMPILING

Refer to the file INSTALL for compilation and installation instructions.
The system has been known to compile on most major platforms:

 - Linux
 - FreeBSD
 - Solaris/SunOS
 - Windows (using the Cygwin tools)
 - IRIX and IRIX64
 - AIX (IBM rs6000 and ParsyTec machines)
 - BeOS

The CDL3 compiler can also be compiled and installed under MS Windows
using the Visual C++ 6.0 compiler. Refer to the subdirectory msvc60
for compilation and installation instructions.

LICENSE

CDL3 is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your
option) any later version.

The CDL3 runtime library (libcdlrts) is licensed under the GNU Library
General Public License (LGPL), thus allowing code generated by cdlc to
be (part of) proprietary applications.

CDL3 is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
License for more details.

QUESTIONS?

Questions, comments, bugs, patches and what's more, are welcome.
Refer to the file AUTHORS for contact information for the maintainers.

  -- Marc Seutter (marcs@cs.ru.nl)

