svn commit: r530623 - /xml/xindice/trunk/README

Author: vgritsenko
Date: Thu Apr 19 20:16:17 2007
New Revision: 530623

URL: http://svn.apache.org/viewvc?view=rev&rev=530623
Log:
some updates to the readme

Modified:
    xml/xindice/trunk/README

Modified: xml/xindice/trunk/README
URL: http://svn.apache.org/viewvc/xml/xindice/trunk/README?view=diff&rev=530623&r1=530622&r2=530623
==============================================================================
--- xml/xindice/trunk/README (original)
+++ xml/xindice/trunk/README Thu Apr 19 20:16:17 2007
@@ -1,6 +1,6 @@
 $Id$
 
-See LICENSE for The Xindice License
+See LICENSE for the Xindice licensing terms.
 
 
 Table of Contents
@@ -26,50 +26,47 @@
 
 The Xindice code base is written in Java.  Because of this, Xindice
 will work on any operating system that supports the Java Developer's
-Kit.  The following is a list of tested platforms and the JDK version
-that was used:
-
-   Platform    Java VM Used
-   =========== ====================
-   Linux       Sun's Java 2 SDK 1.3 (ulimit -s 2048 for SDK 1.3.1)
-   Linux       IBM Java 2 SDK 1.3
-   Windows NT  Sun's Java 2 SDK 1.3
-   Windows XP  Sun's Java 2 SDK 1.4.2
-   Solaris     Sun's Java 2 SDK 1.3
-   Mac OS X    Apple Java 2 SDK 1.3 (Included with Mac OS X)
+Kit.  Xindice is tested on major platforms (Linux, OS X, Windows) and
+Java version (1.3 to 1.5).
 
 
 Release Notes
 -------------
 
-Complete change list for the Apache Xindice releases now available
-online, at:
+Complete change list for the Apache Xindice releases is available
+in the docs directory or online, at:
    http://xml.apache.org/xindice/changes.html
 
-IMPORTANT NOTE: Deployment of Xindice 1.1 is very different 
-from Xindice 1.0. In many ways this should constitute a full
-version change since it isn't really backwards compatible 
-with 1.0. However, the reasons this was done was to simplify
-the code base in preparation for future development. 
-Unfortunately, the new features added do not justify a version 
-change to 2.0. 
+Instructions for upgrading from previous releases are available in
+the docs directory or online, at:
+   http://xml.apache.org/xindice/community/howto/upgrading/
+
+
+IMPORTANT NOTE:
+  Deployment of Xindice 1.1 is very different from Xindice 1.0.
+  In many ways this should constitute a full version change since
+  it is not completely backwards compatible with 1.0. However, the
+  reasons this was done was to simplify the code base in preparation
+  for future development. Unfortunately, the new features added do
+  not justify a version change to 2.0.
 
-- Documentation for this release is badly out of date. Volunteers
-  are needed to update it before 1.1 final is released.
+- Documentation for this release is incomplete. Please submit
+  documentation updates to the developers list.
 
-- Server side installation is now done by deploying a WAR 
-  archive within a Java servlet engine. See the document in 
+- Server side installation is now done by deploying a WAR
+  archive within a Java servlet engine. See the document in
   docs/community/howto/installation/tomcat.html for information
   on using Tomcat. Note: this document needs to be updated along
-  with all the others.
-    
+  with all the others. Embedded Jetty servler engine and startup
+  scripts are included for convenience.
+
 - The database is now deployed within a servlet engine to enable
   network access. This is different from in 1.0 where Xindice had
-  its own server framework. This change was made because the 
-  custom Xindice server framework just duplicated much of the 
+  its own server framework. This change was made because the
+  custom Xindice server framework just duplicated much of the
   functionality provided by servlet engines. This has the nice
   side effect of creating more flexibility in deployment options.
-  
+
 - The network access API is now based on XML-RPC rather then
   CORBA. This was done for simplification and to eliminate the
   constant problems with the CORBA ORB and consumption of
@@ -104,8 +101,9 @@
   automatic deletion has also been removed.
 
 - The command line tools can be run against a network version of
-  Xindice or against a local database. See the -l and -d options
-  to learn more about local database access.
+  Xindice or directly against local database files. See the -l and
+  -d options to learn more about local database access. If using
+  direct file access, please ensure that server process is not running.
 
 - XMLObjects have been removed.
 
@@ -115,6 +113,4 @@
 
 - See bug database for a list of currently open issues, located at
   http://issues.apache.org/bugzilla/buglist.cgi?query_format=specific&bug_status=__open__&product=Xindice
-
-- Some of the test cases are failing.