======================================= This is the README for Max, version 0.1 ======================================= Welcome to Max. The Max web page is http://max.tunes.org/ Max is a framework for reflection implemented in Common LISP. It is intended to be part of a TUNES system. The TUNES project web page is http://tunes.org/ For more information about Max, see the included documentation. Instructions to access the documentation are below. ======================================== Software that may be required to use Max ======================================== * noweb, a literate programming system, to create the LISP code, and the HTML or LaTeX documentation from noweb (.nw) input files -- http://www.eecs.harvard.edu/~nr/noweb/ * GNU Make, to conveniently invoke noweb -- http://www.gnu.org/directory/make.html * A Common LISP interpreter, to run the LISP code -- http://www.cliki.net/Common%20Lisp%20implementation * CVS, to obtain the distribution -- http://www.cvshome.org/ * LaTeX, to typeset the documentation (not required if you only need HTML documentation) -- http://www.latex-project.org/ * DVIPS or pdflatex, included in your TeX distribution, to produce PostScript or PDF documentation * Something to preview or print PostScript, such as gv or lpr, or something to preview or print PDFs, or an HTML viewer =========== Quick Start =========== * Invoke "make" to build the LISP code with noweb * Run your LISP interpreter and (load 'max) or (load 'max.lsp) * Enter (test) to run unit tests and display the results * Enter (menu) to enter the text-based menu system * Enter (repl) to enter the command-line interface (Read-Eval-Print Loop) * Type "make ps", "make pdf", or "make html" to build the documentation in the desired format, or "make doc" to build all formats. ====================================== Files included in the Max distribution ====================================== README - this file *.nw - noweb files, one per module. Code and documentation makefile - instructions for 'make' to build other files todo.txt - list of tasks to do during this development cycle bugs.txt - list of known bugs in Max ================================= Files output by the build process ================================= *.lsp - LISP source code (one per module) *.tex - documentation in LaTeX markup format (one per module) max.dvi - Combined documentation (TeX device-independent output) max.ps - Combined documentation in PostScript format max.pdf - Combined documentation in PDF format max.html - Combined documentation in HTML format *.aux, *.log, *.toc - intermediate files created by TeX Type "make clean" to remove all the generated files. ======= Modules ======= A module in Max is represented by a .nw file, which is processed by noweb to create a .lsp file. The modules in alphabetical order are: adventure - a text adventure game implemented using Max boolean - the Boolean type catalog - catalog of types and functions eval - evaluation of expressions to perform computations function - pure mathematical functions max - the main module menu - text-based menus name - associating strings with addresses object - the objects type ptr - updatable storage of addresses repl - command-line interface (read-eval-print loop) set - mathematical sets string - manipulation of text inside Max test - initialization of the framework for testing Max type - types, values, and addresses util - utility functions dealing with hash tables When adding a new module, the following files need to be updated: README: add module to the above list in its alphabetical position makefile: add module.nw to INPUT_FILES at the point you want the module to be in the HTML docs. If this step is skipped, the module will not be in any of the docs. max.nw: add modulename or modulename.lsp to the call to LOAD-FILES at the point it should be loaded, and add \include{modulename} at the end at the point you want the module to be in the TeX docs modulename.nw: should be created for the new module =================== Directory structure =================== There is one subdirectory, "xptest", which contains a customized version of the XP Test Suite from onShore Development. -- http://alpha.onshored.com/lisp-software/#xptest ======= Credits ======= * David E. Manifold (Tril) http://tril.tunes.org/ - Design, programming, and documentation * Justin R. Hall (HenZo) http://henzo.bespin.org/ - Programming ======= History ======= 2003/07/28 - iteration 1 complete - release 0.1 2002/06/20 - initial import into CVS ===== Legal ===== Max is released into the public domain. The XP Test Suite is also public domain software (see the README file in the "test" directory).