MultiSource/Applications/treecc/README

   1 Tree Compiler-Compiler
   2 ======================
   3
   4 The treecc program is designed to assist in the development of compilers
   5 and other language-based tools.  It manages the generation of code to handle
   6 abstract syntax trees and operations upon the trees.
   7
   8 A fuller account of why treecc exists and what it can be used for can
   9 be found in the Texinfo documentation within the "doc" subdirectory,
  10 and in the introductory article "doc/essay.html".
  11
  12 Downloading and Building
  13 ------------------------
  14
  15 The latest version of treecc can be obtained from the following Web site:
  16
  17     http://www.southern-storm.com.au/treecc/
  18
  19 To build and install, unpack the ".tar.gz" file into a temporary directory
  20 and execute the following commands:
  21
  22     $ ./configure
  23         $ make all
  24         $ make check
  25         $ make install
  26
  27 The "make check" runs the treecc test suite to check for any problems
  28 on your system.  Report any such problems to the authors, together with
  29 a script of the failed test output.
  30
  31 If you obtained the treecc sources via CVS, you will need to run the
  32 following before "./configure":
  33
  34         $ ./auto_gen.sh
  35
  36 If you wish to install treecc somewhere other than the default prefix
  37 ("/usr/local"), use the following configuration command instead:
  38
  39     $ ./configure --prefix=PREFIX
  40
  41 where "PREFIX" is the full pathname of the directory where you want to
  42 install the program.
  43
  44 If you want to add a new output language, see "doc/extending.txt".
  45
  46 Copyright Considerations
  47 ------------------------
  48
  49 Treecc is distributed under the terms of the GNU General Public License.
  50 A copy of this can be found in the "COPYING" file.
  51
  52 However, it is not our intention to restrict the use of treecc to only
  53 free software providers.  Use by commercial software vendors is welcome.
  54
  55 When you use treecc on your own input files to generate source code as
  56 output, the resulting source code files are also owned by you.  You may
  57 re-distribute unmodified copies of these output source files, and any
  58 binaries derived from them, in any way you see fit.
  59
  60 If you modify treecc itself, and generate new output files as a result,
  61 then you must release all modifications to treecc with your program so
  62 that other users can benefit from your changes under the terms of the GPL.
  63
  64 Contact the authors if you have any questions regarding the above.
  65 It is our intention to allow the same amount of access to treecc output
  66 files as is currently available using the GNU Bison and Flex programs.
  67
  68 Contacting the Authors
  69 ----------------------
  70
  71 The authors can be contacted via e-mail at the following address:
  72
  73     treecc@southern-storm.com.au
  74
  75 Also check our Web site for updates to treecc:
  76
  77     http://www.southern-storm.com.au/treecc/