home *** CD-ROM | disk | FTP | other *** search
/ Phoenix CD 2.0 / Phoenix_CD.cdr / 01e / max130.zip / README.DOC < prev    next >
Text File  |  1988-10-30  |  7KB  |  180 lines

  1.  
  2.  
  3.     Max, The Programming Language, Version 1.30
  4.     Copyright (c) Anthony F. Stuart, 1988. All rights reserved.
  5.  
  6.  
  7.     THIS IS EXPERIMENTAL SOFTWARE. USE IT AT YOUR OWN RISK. THE 
  8.     AUTHOR SHALL NOT BE LIABLE FOR ANY DIRECT, CONSEQUENTIAL, OR
  9.     INCIDENTAL DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE.
  10.     THIS SOFTWARE IS SUPPLIED AS-IS AND IS NOT SUPPORTED.
  11.  
  12.  
  13.     1.0  Getting Started
  14.  
  15.          Max may be run from the distribution diskette or from a
  16.     hard disk. To run from a hard disk, create a directory and copy
  17.     all of the files to the directory. Run Max from the directory.
  18.  
  19.          The Max configuration file (config.max) is set up to load
  20.     the integrated environment. A command entry window and a function
  21.     definition window are displayed. The size, location and color of
  22.     these windows is defined in window.max and may be changed if
  23.     desired. The default is monochrome with two equal sized tiled
  24.     windows. Remove the reference to window.max from the configuration
  25.     file if you do not want to use the integrated environment.
  26.  
  27.          The command entry window provides an interactive session
  28.     with the Max command interpreter. Commands are entered by typing
  29.     the function name and any arguments. The command is sent when a
  30.     carriage return is entered. It is not necessary to retype a
  31.     command. Just position the cursor to the right of the text you
  32.     wish to send and press return. All text to the left of the
  33.     cursor is sent. See maxedit.doc for more information.
  34.  
  35.          The configuration file also loads several demonstration
  36.     programs. These may be run by entering the name of the program
  37.     and a null argument list. Try dir(), type() and showsine(). Max
  38.     is a function oriented language and will not act on a command
  39.     until it reads the argument list, even if the list is null. If
  40.     Max is ignoring you, type control c to return to command level.
  41.  
  42.          The function definition window can be used to create or
  43.     edit functions. The primary difference between the two windows
  44.     is that carriage return is handled differently in the function
  45.     definition window. It does not send the line to the command
  46.     interpreter but simply positions to the next line. To send
  47.     the contents of the function definition window to the command
  48.     interpreter (i.e. compile a function), use function key F1.
  49.  
  50.          To enter a simple demo function in the function definition 
  51.     window, use Alt-N to select the window and type:
  52.  
  53.         Function first
  54.             Begin
  55.                 print ("Hello world, the time is " time () )
  56.             End
  57.         EndFunction
  58.  
  59.     Press F1 to compile the program and return to the command
  60.     entry window. Then type first() to run it. To clear a program
  61.     from memory enter tclear(). This clears all programs defined
  62.     since the last tset(). Max will complain about a duplicate
  63.     function definition if you do not clear the transient area
  64.     before compiling a new version of the same function. Put a
  65.     call to tclear in the function definition window if you want
  66.     to automatically clear the transient area before compiling a
  67.     program. Be sure to put it before your function definition.
  68.     To exit the Max integrated environment press function key F10
  69.     or use the quit() builtin function.
  70.  
  71.  
  72.     2.0  Files
  73.  
  74.     The following files constitute version 1.30 of Max. They may
  75.     be copied and transferred provided that they are not modified
  76.     in any way and that no fee is charged. Any other distribution
  77.     of these files requires the written permission of the author.
  78.     
  79.     2.1  Executable
  80.  
  81.     MAX.EXE    - This file contains the executable code for the Max
  82.     interpreter and the MaxEdit integrated environment.
  83.     
  84.  
  85.     2.2  Documentation
  86.  
  87.     The Max Reference Manual is composed of five files:
  88.  
  89.     INTRO.DOC - This file contains a description of the basic features
  90.     and elements of the Max programming language and is required
  91.     reading for getting started in Max.
  92.  
  93.     SUMMARY.DOC - This file contains a summary of all of the Max
  94.     builtin functions. It is useful for getting an overview of the
  95.     functions available through Max and for finding related functions.
  96.  
  97.     DETAIL1.DOC - This is the first half of the detailed description
  98.     of Max builtin functions. This half contains the naming conventions
  99.     used in both the detailed description files.
  100.  
  101.     DETAIL2.DOC - This is the second half of the detailed description
  102.     of Max builtin functions. Both sections are useful for finding out
  103.     more about each function, including calling sequence/argument lists.
  104.  
  105.     MAXEDIT.DOC - This file contains a description of the MaxEdit
  106.     integrated environment and editor. It includes a summary of
  107.     the editing commands, followed by detailed information.
  108.  
  109.  
  110.     2.3  Max Source Files
  111.  
  112.     CONFIG.MAX - This file contains the configuration parameters for
  113.     the Max translator interpreter. It is used by Max during startup.
  114.     It contains a description of all available parameters.
  115.  
  116.     BLOCK.MAX - This file contains several preprocessor definitions
  117.     that make it easier to write structured code. Each flow of control
  118.     block is defined as a Begin ... End pair.
  119.  
  120.     WINDOW.MAX - This file contains the initialization code for the
  121.     MaxEdit integrated environment. It allows you, for example, to
  122.     change the size, color and other attributes of the default windows.
  123.  
  124.     SAMPLE.MAX - This file contains sample Max programs to get you
  125.     started and provides a few useful utilities that can be used from
  126.     within the MaxEdit integrated environment.
  127.  
  128.     WINDEF.MAX - This file contains window command definitions for
  129.     use with the window builtin function.
  130.  
  131.     ANIMAL.MAX - This file contains a simple Max program that
  132.     illustrates machine learning by asking the user to think of
  133.     an animal and then trying to guess it.
  134.  
  135.     LSTNAV.MAX - This file contains a simple Max program that
  136.     allows the user to create and modify lists and play with the
  137.     basic list processing primitives.
  138.  
  139.     ARYNAV.MAX - This file contains a simple Max program that
  140.     allows the user to create and modify arrays and play with the
  141.     basic array processing primitives.
  142.  
  143.     SHELL.MAX - This file contains the framework of a Max command
  144.     processing shell, good for users who like an input prompt.
  145.  
  146.     TRIM.MAX - This file contains several general purpose string
  147.     functions that illustrate the use of the pattern matching
  148.     primitives.
  149.     
  150.     To load a Max source file that is not loaded by CONFIG.MAX,
  151.     use the feval builtin function. Try feval("animal.max") for
  152.     example.
  153.  
  154.  
  155.     3.0  Comments
  156.  
  157.     If you have any comments or questions about Max, please send them
  158.         to the author at this address:
  159.  
  160.         Anthony F. Stuart
  161.         The Max Development Center
  162.         21042 Thoreau Court
  163.         Sterling, VA 22170
  164.  
  165.  
  166.     4.0  Source Code
  167.  
  168.          If you would like to learn more about Max, or modify and
  169.     personalize it, you may order a copy of the source code. Max was
  170.     written in the 'C' programming language. The source is commented
  171.     and consists of approximately 20,000 lines. It is available on
  172.     360 kbyte 5.25 inch diskette. Please send check or money order
  173.     for $20.00 to the author at the above address. This offer may
  174.     be withdrawn at any time.
  175.  
  176.          Please note that the source to Max is for your personal
  177.     use only. It may not be distributed in any form or used in any
  178.     other software without the written permission of the author.
  179.  
  180.