incubator-connectors-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kwri...@apache.org
Subject svn commit: r1056173 - in /incubator/lcf/trunk: CHANGES.txt README.txt
Date Fri, 07 Jan 2011 02:44:31 GMT
Author: kwright
Date: Fri Jan  7 02:44:31 2011
New Revision: 1056173

URL: http://svn.apache.org/viewvc?rev=1056173&view=rev
Log:
CONNECTORS-132: Revise README.txt to be consistent with new deliverable.

Modified:
    incubator/lcf/trunk/CHANGES.txt
    incubator/lcf/trunk/README.txt

Modified: incubator/lcf/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/CHANGES.txt?rev=1056173&r1=1056172&r2=1056173&view=diff
==============================================================================
--- incubator/lcf/trunk/CHANGES.txt (original)
+++ incubator/lcf/trunk/CHANGES.txt Fri Jan  7 02:44:31 2011
@@ -14,6 +14,10 @@ forget the index state for an output con
 ======================= Release 0.1 =======================
 Release Date:  See http://incubator.apache.org/connectors for the official release date.
 
+CONNECTORS-132: Remove build artifacts from the archives, except for documentation.
+This is to save space.
+(Karl Wright)
+
 CONNECTORS-136: Change rat-sources build target to exclude all files known good
 despite RAT complaints.
 (Sebb, Karl Wright)

Modified: incubator/lcf/trunk/README.txt
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/README.txt?rev=1056173&r1=1056172&r2=1056173&view=diff
==============================================================================
--- incubator/lcf/trunk/README.txt (original)
+++ incubator/lcf/trunk/README.txt Fri Jan  7 02:44:31 2011
@@ -27,16 +27,31 @@ http://incubator.apache.org/connectors
 Getting Started
 ---------------
 
-See the "dist/example" directory for an example ManifoldCF setup.  Start the example
-by going to that directory and typing "<path_to_java> -jar start.jar".  Full documentation
-can also be found in "dist/doc".
+You will need to build ManifoldCF before you can do anything else.
+
+Instructions for Building Apache ManifoldCF from Source
+-----------------------------------------------------
+
+1. Download the Java SE 5 JDK (Java Development Kit), or greater, from http://java.sun.com.
+   You will need the JDK installed, and the %JAVA_HOME%\bin directory included
+   on your command path.  To test this, issue a "java -version" command from your
+   shell and verify that the Java version is 1.5 or greater.
+
+2. Download the Apache Ant binary distribution (1.7.0 or greater) from http://ant.apache.org.
+   You will need Ant installed and the %ANT_HOME%\bin directory included on your
+   command path.  To test this, issue a "ant -version" command from your
+   shell and verify that Ant is available.
+
+3. If you want to build the site documents, check out, build, and install Apache Forrest
+   version 0.9-dev.
+   
+4. In a shell, change to the root directory of the source (where you find the outermost
+   build.xml file), and type "ant" for directions.
+
 
 Some Files Included In Apache ManifoldCF Distributions
 ----------------------------------------------------
 
-dist/example
-  The Apache ManifoldCF Quick Start example environment.
-
 dist/doc/index.html
   The Apache ManifoldCF documentation root, which includes the Javadoc.
 
@@ -55,24 +70,12 @@ site
 build.xml
   The root ant build script for Apache ManifoldCF.
 
+Running the example
+--------------------
 
-Instructions for Building Apache ManifoldCF from Source
------------------------------------------------------
-
-1. Download the Java SE 5 JDK (Java Development Kit) from http://java.sun.com.
-   You will need the JDK installed, and the %JAVA_HOME%\bin directory included
-   on your command path.  To test this, issue a "java -version" command from your
-   shell and verify that the Java version is 1.5.  You may also use later versions of
-   Java SE, but you will not be able to build the documentation if that is the version
-   you use.
-
-2. Download the Apache Ant binary distribution (1.7.0 or greater) from http://ant.apache.org.
-   You will need Ant installed and the %ANT_HOME%\bin directory included on your
-   command path.  To test this, issue a "ant -version" command from your
-   shell and verify that Ant is available.
-   
-3. In a shell, change to the root directory of the source (where you find the outermost
-   build.xml file), and type "ant" for directions.
+After you build, the example can be found under dist/example.  Start the example
+by going to that directory and typing "<path_to_java> -jar start.jar".  Full documentation
+can also be found in "dist/doc".
 
 Licensing
 ---------



Mime
View raw message