==============================================================================
XWT README 
              
______________________________________________________________________________
Documentation

If you're new to XWT, you should read the documentation in the order
presented below:

- README [this file]
        
      Start here. Includes a map of all other documentation and a
      description of the directory strucure

- The XWT home page [http://www.xwt.org/]       
          
- The XWT tutorial [http://www.xwt.org/tutorial.html]

      Gentle introduction to what XWT is, and how to write
      .xwt's. Good for anybody who wants to write XWT applications.

- The XWT reference [http://www.xwt.org/reference.html]
        
      Precise, technical spec of exactly how XWT works. Assumes
      familiarity with XWT (ie, you've read the tutorial). This is the
      authoritative source for how an XWT engine should
      behave.


______________________________________________________________________________
Directory Structure

/       
   AUTHORS                - people involved in developing XWT   
   README                 - this file
   COPYING                - copyright information for all files in this distro
   CHANGES                - the changelot
   TM                     - trademark information for XWT       
   Makefile               - build file for gcc 3.3
   next.build             - the build id of the next build to be generated

   build/                 - anything generated by the build process winds up here
         h/               - header files generated by gcjh
         java/            - auto-generated .java source files
         class/           - java .class files
         xwar/            - generated xwars (mainly builtin.xwar)
         Linux/           - Linux binaries
         Win32/           - Win32 binaries
         Carbon/          - MacOS X / Carbon binaries
         Solaris/         - Solaris binaries

   gcc/                   - build area for a custom copy of gcc3.3 and binutils2.13
       Makefile           - will download, configure, compile, and private-install gcc3.3/binutils2.13
       gcc.patch          - a patch to make boehm-gc work on Darwin (Mac OS X)
   lib/                   - any third-party binary stuff needed during the build process
       javago             - a copy of the javago post-compilation bytecode inliner
       netscape.jar       - minimal set of classes required for compiling against Netcape's Applet interfaces
       msjvm.jar          - minimal set of classes required for compiling against Microsoft's Applet interfaces
       jump.jar           - the jump2 bytecode-to-palmos translator
       libgcj-minimal.jar - a tiny portion of libgcj.jar; allows java->bytecode compilation without gcj
   src/                   - all java source files and xwt sources go here
       org/
           bouncycastle/  - the BouncyCastle Crypto Library
           mozilla/       - a copy of Rhino, the Mozilla JavaScript interpreter
           ijg/           - as part of the build process, the Independent JPEG Group's JPEG implementation gets put here
           xwt/builtin/   - .xwt's and .png's that are essential to bootstrapping the engine
           xwt/plat/      - platform-specific code
           xwt/util/      - misc utilities
           xwt/js/        - the XWT JavaScript Interpreter


______________________________________________________________________________
Build Requirements

**** STOP! ****

Compiling the engine is Really Hard.  Unless you're planning on
helping develop the engine, you probably don't need (or want) to
compile it yourself!

There are pre-built, digitally signed binaries on http://dist.xwt.org/
for every supported platform.  Please consider using those unless
you're absolutely certain you need to go through the trouble of trying
to get XWT to build.  You have been warned.  Please do not post to the
mailing lists asking for help building XWT unless you're genuinely
interested in helping to develop the engine.

Requirements:
    - jdk 1.4+
    - the standard set of POSIX utilities (wc, grep, find, make, etc)

Automatically-Downloaded components:
    - gcj 3.3+
    - binutils 2.13+
    * If you already have a suitably configured gcj 3.3 and binutils
      2.13+ you can set "gcc_path" to point at its installation
      location; otherwise the Makefile will download, configure,
      compile, and install gcc and binutils in xwt/gcc/

Optional components:
    - fastjar (builds archives faster)
    - jikes 1.18 (makes builds go much faster)
    * If jikes is in your $PATH, the Makefile will find and use it.
      Otherwise you can type 'make jikes' to download and build jikes.

Build Targets:
    - compile: compiles all .java files into bin/*.class
    - Win32:   Win95 OSR2 or later
    - Linux:   Linux 2.2 or later
    - Java2:   Any Java 1.2+ compliant JVM
    - Darwin:  Any Darwin-based OS (Mac OS X, OpenDarwin) with an X11 server
    - clean:   cleanup