projects / org.ibex.core.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
2003/03/20 02:55:54
[org.ibex.core.git] / README
diff --git a/README b/README
index 08be636..dfb9b39 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,7 @@
 ==============================================================================
 XWT README
 ==============================================================================
 XWT README
- 
+
+      
 ______________________________________________________________________________
 Documentation
 
 ______________________________________________________________________________
 Documentation
 
@@ -8,19 +9,19 @@ If you're new to XWT, you should read the documentation in the order
 presented below:
 
 - README [this file]
 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/]
       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]
 - 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
       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
@@ -31,77 +32,50 @@ ______________________________________________________________________________
 Directory Structure
 
 /
 Directory Structure
 
 /
-   AUTHORS               - people involved in developing XWT
-   README                - this file
-   COPYING               - copyright information for all files in this distro
-   TM                    - trademark information for XWT
-   ant                   - a unix shell script to launch ant
-   bin/                  - all binary stuff generated by ant builds
-
-   build.xml             - ANT build file
-   Makefile              - build file for gcc 3.3
-
-   lib/                  - any third-party binary stuff needed during the build process
-       javago            - a copy of the javago post-compilation bytecode inliner
-       ant.jar           - the Jakarta project's ANT build tool, including Sun's XML parser
-       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
-       javasrc.jar       - javasrc, a tool for generating hyperlinked, syntax-colored html from java code
-
-   src/                  - all java source files and xwt sources go here
+   AUTHORS                - people involved in developing XWT
+   README                 - this file
+   COPYING                - copyright information for all files in this distro
+   TM                     - trademark information for XWT
+   Makefile               - build file for gcc 3.3
+   next.build             - the build id of the next build to be generated
+   bin/                   - all binary stuff generated by xwt builds
+   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
+   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/
        org/
-           bouncycastle/ - the BouncyCastle Crypto Library
-           mozilla/      - a copy of Rhino, the Mozilla JavaScript interpreter
-           xwt/builtin/  - .xwt's and .png's that are essential to bootstrapping the engine
-           xwt/plat/     - platform-specific code
-
-______________________________________________________________________________
-Build Targets
-
-        *** XWT now requires JDK 1.4 or later to build ***
-
-To build, make sure your $JAVA_HOME points to jdk1.4 or later, and type
-
-    ./ant -Dplat=<platform> <targetname>
-
-The name of any class in org.xwt.plat is a valid <platform>; here is a
-list as of 20-Mar-2002:
-
-    Win32         - Windows 95 / NT4 or later
-    Java12        - Any Java 1.2+ compliant JVM
-
-Valid <target>s are:
-
-    build         - builds a binary for the selected platform
-
-The following targets do not require that you specify a platform:
-
-    compile       - compiles all .java's to .class'es
-    clean         - empties bin/ and compiled binaries in dist/
-
+           bouncycastle/  - the BouncyCastle Crypto Library
+           mozilla/       - a copy of Rhino, the Mozilla JavaScript interpreter
+           xwt/builtin/   - .xwt's and .png's that are essential to bootstrapping the engine
+           xwt/plat/      - platform-specific code
 
 ______________________________________________________________________________
 
 ______________________________________________________________________________
-Building
-
-- WARNING: Jikes 1.16 has a bug which will cause it to generate
-  corrupt .class files; you must downgrade to 1.15 in order to compile
-  XWT.
-
-- If you only want to build the JVM version of XWT, delete these three
-  files:
-
-    xwt/src/org/xwt/plat/Win32.java
-    xwt/src/org/xwt/plat/POSIX.java
-    xwt/src/org/xwt/plat/GCJ.java
-
-  This will allow XWT to build correctly *without* gcc 3.1. Otherwise,
-  you must compile and install gcc 3.1.
-
-- The Win32 native version of XWT can ONLY be built with the very
-  latest pre-release of GCC 3.3.  Run "make gcc-lin" to build a gcc
-  3.3 that targets Linux; run "make gcc-win" to build a gcc 3.3 that
-  targets Win32.
-
+Build Targets and Requirements
+
+Build requirements:
+- jdk 1.4+
+- jikes (warning: Jikes 1.16 has a fatal bug; use 1.15)
+- gcj 3.3+
+- binutils 2.13+
+- fastjar
+
+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.
+
+Public build targets:
+
+    compile       - compiles all .java files into bin/*.class
+    Win32         - Win95 or later (bin-Win32/xwt.exe)
+    Linux         - Linux 2.2 or later (bin-Linux/xwt.linux)
+    Java2         - Any Java 1.2+ compliant JVM
+    clean         - cleanup
 
 
 ______________________________________________________________________________
 
 
 ______________________________________________________________________________
Unnamed repository; edit this file to name it for gitweb.