svn commit: r507019 - /incubator/uima/uimaj/trunk/uimaj-distr/src/main/readme/README

[sc...@apache.org]

Author: schor
Date: Tue Feb 13 06:27:04 2007
New Revision: 507019

URL: http://svn.apache.org/viewvc?view=rev&rev=507019
Log:
UIMA-240 Review, slight editing / clarifiations

Modified:
    incubator/uima/uimaj/trunk/uimaj-distr/src/main/readme/README

Modified: incubator/uima/uimaj/trunk/uimaj-distr/src/main/readme/README
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uimaj-distr/src/main/readme/README?view=diff&rev=507019&r1=507018&r2=507019
==============================================================================
--- incubator/uima/uimaj/trunk/uimaj-distr/src/main/readme/README (original)
+++ incubator/uima/uimaj/trunk/uimaj-distr/src/main/readme/README Tue Feb 13 06:27:04 2007
@@ -10,7 +10,7 @@
 should work, but have not been significantly tested.
 
 Many of the scripts in the /bin directory invoke Java. They use the value of the environment variable, JAVA_HOME, 
-to locate the Java to use.
+to locate the Java to use; if it is not set, they invoke "java". 
 
 
 Environment Variables
@@ -23,11 +23,14 @@
     * Set UIMA_HOME to the apache-uima directory of your unpacked Apache UIMA distribution
     * Append UIMA_HOME/bin to your PATH
     
-    * It is recommended to run the script UIMA_HOME/bin/adjustExamplePaths.bat (or .sh), which updates some 
-      hard coded paths in the examples to your actual UIMA_HOME directory. This script runs a Java program; 
-      you will need to set the environment variable JAVA_HOME to a suitable Java on your machine before running this script.
+    * Please run the script UIMA_HOME/bin/adjustExamplePaths.bat (or .sh), to update 
+      paths in the examples based on the actual UIMA_HOME directory path. 
+      This script runs a Java program; 
+      you may to set the environment variable JAVA_HOME to a suitable Java on your machine 
+      before running this script.
 
-      Note: For MacOSX, see http://developer.apple.com/qa/qa2001/qa1067.html for how to do this.
+    Note: The Mac OS X operating system has special procedures for setting up global environment
+    variables; see http://developer.apple.com/qa/qa2001/qa1067.html for how to do this.
       
       
 Verifying Your Installation
@@ -49,7 +52,9 @@
 Getting Started
 ----------------
 
-For an introduction to Apache UIMA and how to use it, please read the documentation located in the docs subdirectory.
+For an introduction to Apache UIMA and how to use it, please read the documentation 
+located in the docs subdirectory.  A good place to start is the overview_and_setup 
+book's first chapter, which has a brief guide to the documentation.
 
 
 Disclaimer