8. CONTENTS

Start data section to CONTENTS[1 /1 ]
     1: The tarball contains the literate programmed original sources,
     2: all the sources derived from that by running interscript,
     3: including Ocaml sources for the compiler, C++ sources for
     4: the run time components, build scripts, documentation,
     5: the tutorial, and all the examples and regression tests,
     6: the codes generated by running Felix against the examples,
     7: and finally, a linux binary version of the compiler
     8: and program driver.
     9: 
    10: Top level files:
    11: 
    12:   VERSION   current version number, should be 1.1.3_rc4
    13:   CONTENTS  (this file)
    14:   README    the usual readme file
    15:   INSTALL   how to install and build felix
    16:   LICENCE   licence details
    17:   AUTHORS   list of contributors
    18:   NEWS      handy place to plug Felix
    19:   ChangeLog where change info should go but doesn't
    20: 
    21:   config/buildno.txt contains the build sequence number
    22:             this must differ between builds in case
    23:             Marshalled data format changes
    24:             it may not exist when you start,
    25:             the script/maker script creates it
    26:             when necessary
    27: 
    28:   Makefile   the makefile, mainly hooks into script/maker
    29: 
    30:   script/maker  This is the main make script, written in Python
    31: 
    32: The directories are:
    33: 
    34:   config  -- user configuration data
    35: 
    36:   lpsrc   -- LP original sources, contains EVERYTHING you need
    37:              if you have the full tool chain installed
    38: 
    39:   lpbackup -- backup of LP sources (make backups with 'make backup' :)
    40: 
    41:   interscript -- the complete interscript package
    42:   src     -- ocaml source code for the compiler
    43:   test    -- regression tests and driver programs
    44:   doc     -- the complete documented source of the compiler
    45:   htmlman -- man pages converted to html by htmlman
    46: 
    47:   tut/doc -- the tutorial
    48:   tut/examples  -- examples from the tutorial
    49:   www    -- the top level of the sourceforge web site
    50:   script -- python build script
    51:   misc   -- misc files including vim syntax colouring file
    52:   meta   -- contains various package manager meta-data files
    53:   lib    -- felix standard library
    54:   man    -- man pages for tools and some language features
    55:   bin    -- compiler tools directory
    56:   rtl    -- C++ run time library sources
    57: 
End data section to CONTENTS[1]