InteLib documentation summary
Documentation which comes with the sources
NOTE: these files are also found in the directory
docs/ inside the source tarball.
- readme.txt gives you a
brief introduction and general concept overview
- build.txt explains how
to build the Lisp part of the library and how to bootstrap
the Lisp-to-C++ translator supplied along with
- lispkern.txt
briefly explains the kernel of the Lisp part (the file is
under construction now)
- platform.txt describes
what platforms and compilers it is known to compile and run on
- ill.txt
explains ILL -- the Lisp-to-C++ translator which accompanies
the library
- nill.txt
explains NILL -- the iNteractive InteLib Lisp interpreter
- ill_lang.txt defines the
InteLib Lisp -- the Lisp dialect which is accepted by ILL.
- dirtree.txt describes the
directory layout inside the InteLib tarball.
- defines.txt describes macro
definitions which control compile-time options of the library.
- lispfuns directory contains
files describing InteLib-specific Lisp "built-in" functions
Source documentation generated with Doxygen
NOTE: having
Doxygen
and the source tarball you can
generate such a documentation yourself. Just type make doxydocs
Last updated December 18, 2007