2002/07/01 19:45:32
[org.ibex.core.git] / README
diff --git a/README b/README
index 10b4465..bb741d5 100644 (file)
--- a/README
+++ b/README
@@ -12,37 +12,30 @@ presented below:
       Start here. Includes a map of all other documentation and a
       description of the directory strucure
 
       Start here. Includes a map of all other documentation and a
       description of the directory strucure
 
-- The XWT home page [www/ or http://www.xwt.org/]
+- The XWT home page [http://www.xwt.org/]
 
 
-      A complete copy of all static and dynamic content for
-      www.xwt.org is in the xwt/www/ directory.
-
-- The XWT tutorial [www/html/tutorial.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.
 
 
       Gentle introduction to what XWT is, and how to write
       .xwt's. Good for anybody who wants to write XWT applications.
 
-- The XWT reference [www/html/reference.html]
+- 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.
 
 
       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.
 
-- Javadoc [www/html/javadoc/package-summary.html]
+- Javadoc [http://www.xwt.org/javadoc/]
 
 
-      The org.xwt.* packages are all documented with javadoc. If
-      you've just checked out or downloaded a fresh copy of the XWT
-      distribution, you can generate the javadoc by typing
-      "./ant www" at the root directory of the distribution. You
+      The org.xwt.* packages are all documented with javadoc. You
       should start by reading the package summary for org.xwt.Main,
       and work your way around from there.
 
       should start by reading the package summary for org.xwt.Main,
       and work your way around from there.
 
-- Javasrc [www/html/javasrc/index.html]
+- Javasrc [http://www.xwt.org/javasrc]
 
       Javasrc generates a syntax-colored and hyperlinked html copy of
 
       Javasrc generates a syntax-colored and hyperlinked html copy of
-      the XWT source code. To generate this documentation, type "./ant www"
-      from the root directory of the distribution.
+      the XWT source code.
 
 
 ______________________________________________________________________________
 
 
 ______________________________________________________________________________
@@ -55,14 +48,6 @@ Directory Structure
    ant                   - a unix shell script to launch ant
    bin/                  - all binary stuff generated by ant builds
    build.xml             - ANT build file
    ant                   - a unix shell script to launch ant
    bin/                  - all binary stuff generated by ant builds
    build.xml             - ANT build file
-   doc/                  - documentation
-
-   www/                  - a copy of all static and dynamic content on xwt.org
-       etc/              - configuration files
-       html/             - static content -- files ending with an underscore get
-                           prefix.html/suffix.html/tagline.html added to them
-       launch/           - code for launch.xwt.org
-       src/              - source code for servlets running on xwt.org
 
    lib/                  - any third-party binary stuff needed during the build process
        javago            - a copy of the javago post-compilation bytecode inliner
 
    lib/                  - any third-party binary stuff needed during the build process
        javago            - a copy of the javago post-compilation bytecode inliner
@@ -100,7 +85,9 @@ Directory Structure
 ______________________________________________________________________________
 Build Targets
 
 ______________________________________________________________________________
 Build Targets
 
-To build, make sure your $JAVA_HOME points to jdk1.2 or later, and type
+        *** 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>
 
 
     ./ant -Dplat=<platform> <targetname>
 
@@ -113,26 +100,21 @@ list as of 20-Mar-2002:
 Valid <target>s are:
 
     build         - builds a binary for the selected platform
 Valid <target>s are:
 
     build         - builds a binary for the selected platform
-    dist          - creates deployment materials for the selected platform in dist/
-    run           - runs the 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/
 
 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/
-    www           - rebuild www/html/
-    push          - push changes to the web server via ssh (RSA auth)
-
-
 
 
 ______________________________________________________________________________
 Building
 
 
 
 ______________________________________________________________________________
 Building
 
-- If you only want to build the JVM version of XWT, delete these two
+- If you only want to build the JVM version of XWT, delete these three
   files:
 
     xwt/src/org/xwt/plat/Win32.java
   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,
     xwt/src/org/xwt/plat/GCJ.java
 
   This will allow XWT to build correctly *without* gcc 3.1. Otherwise,
@@ -149,8 +131,11 @@ Building
   without it, however, since it puts additional strain on the gcc cvs
   server.
 
   without it, however, since it puts additional strain on the gcc cvs
   server.
 
-  There's also a patch at the end of this file which can be applied to
-  the branch in order to make Throwable.printStackTrace() work.
+  There are also three patches at the end of this file which can be
+  applied to the branch -- the first fixes a bug related to
+  GetFullPathName, the second disables Win32 file locking (so you can
+  view XWT's log files while it is running), and the third makes
+  Throwable.printStackTrace() work.
 
   # create an install area
   export CLASSPATH=
 
   # create an install area
   export CLASSPATH=
@@ -197,6 +182,18 @@ Building
   make
   sudo make install
 
   make
   sudo make install
 
+- The Linux native version is still experimental. You should configure
+  your compiler with:
+
+  ../gcc/configure \
+                   --prefix=$PREFIX \
+                   --enable-languages=c,c++,java \
+                   --disable-nls \
+                   --enable-libgcj \
+                   --enable-threads=posix \
+                   --enable-hash-synchronization \
+                   --enable-static \
+                   --disable-interpreter
 
 
 ______________________________________________________________________________
 
 
 ______________________________________________________________________________
@@ -419,3 +416,8 @@ diff -u -r1.11 natThrowable.cc
 +    return (jlong)stack[i];
 +}
 +
 +    return (jlong)stack[i];
 +}
 +
+
+
+
+
+