use //#jswitch more
[org.ibex.core.git] / README
diff --git a/README b/README
index a582b93..095be99 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,12 @@
 ==============================================================================
-XWT README 
+Ibex README 
+
+Test
               
 ______________________________________________________________________________
 Documentation
 
-If you're new to XWT, you should read the documentation in the order
+If you're new to Ibex, you should read the documentation in the order
 presented below:
 
 - README [this file]
@@ -12,18 +14,18 @@ presented below:
       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 Ibex home page [http://www.ibex.org/]       
           
-- The XWT tutorial [http://www.xwt.org/tutorial.html]
+- The Ibex tutorials [http://www.ibex.org/tutorials.html]
 
-      Gentle introduction to what XWT is, and how to write
-      .xwt's. Good for anybody who wants to write XWT applications.
+      Gentle introduction to what Ibex is, and how to write
+      .ibex's. Good for anybody who wants to write Ibex applications.
 
-- The XWT reference [http://www.xwt.org/reference.html]
+- The Ibex reference [http://www.ibex.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 Ibex works. Assumes
+      familiarity with Ibex (ie, you've read the tutorial). This is the
+      authoritative source for how an Ibex engine should
       behave.
 
 
@@ -31,73 +33,72 @@ ______________________________________________________________________________
 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
-   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
-       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
+   AUTHORS                  - people involved in developing Ibex   
+   README                   - this file
+   COPYING                  - copyright information for all files in this distro
+   CHANGES                  - the changelot
+   TM                       - trademark information for Ibex       
+   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)
+         mips/              - mips binaries (interpreted on all platforms)
+         JVM/               - java Jar archives
+         Linux/             - Linux binaries
+         Win32/             - Win32 binaries
+         Darwin/            - Darwin binaries
+         Solaris/           - Solaris binaries
+
+   Makefile.upstream        - build/download/install instructions for upstream packages
+   upstream/                - download, build, and install area for upstream packages
+            install/        - this is the --prefix for all configure invocations
+            gcc-3.3/        - build/download area for gcc
+            jpeg-6b/        - build/download area for libjpeg
+            freetype-2.1.4/ - build/download area for freetype
+            newlib-1.11.0/  - build/download area for newlib
+            darwin-linker/  - build/download area for a hacked version of Apple's binutils
+
+   lib/                     - any third-party binary stuff needed during the build process
+       javago               - a copy of the javago post-compilation bytecode inliner
+       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 ibex sources go here
+       edu/stanford/ejalbr  - source code for BrowserLauncher
+       gnu/regexp/          - source code for the GNU regexp library for Java
        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
+           bouncycastle/    - the BouncyCastle Crypto Library
+           ibex/
+               translators/ - .ibex's and .png's that are essential to bootstrapping the engine
+               plat/        - platform-specific code
+               util/        - misc utilities
+               js/          - the Ibex JavaScript Interpreter
+               mips/        - the Ibex MIPS interpreter/recompiler
+               builtin/     - content for the core builtin resource
 
 
 ______________________________________________________________________________
 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/
+There are pre-built, digitally signed binaries on http://dist.ibex.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.
+to get Ibex to build.
 
 Requirements:
-    - jdk 1.4+
+    - jdk 1.3+
     - 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
+    - compile: compiles all .java files into build/class/
+    - JVM:     Any true Java JVM (ie not GCJ)
     - 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
+    - Darwin:  Any Darwin-based OS (Mac OS X, OpenDarwin)
+    - Solaris: Solaris 2.7+
+    - clean:   always run this after doing a 'cvs update'