svn commit: r1041763 - in /incubator/lcf/trunk: README.txt build.xml

[kw...@apache.org]

Author: kwright
Date: Fri Dec  3 10:27:12 2010
New Revision: 1041763

URL: http://svn.apache.org/viewvc?rev=1041763&view=rev
Log:
Flesh out the README file so that it actually gives enough help to get started.

Modified:
    incubator/lcf/trunk/README.txt
    incubator/lcf/trunk/build.xml

Modified: incubator/lcf/trunk/README.txt
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/README.txt?rev=1041763&r1=1041762&r2=1041763&view=diff
==============================================================================
--- incubator/lcf/trunk/README.txt (original)
+++ incubator/lcf/trunk/README.txt Fri Dec  3 10:27:12 2010
@@ -1,7 +1,78 @@
-ManifoldCF
-=======
-
-Welcome to the ManifoldCF top-level Apache project, under incubation.
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Welcome to the Apache ManifoldCF project!
+-----------------------------------------
+
+Apache ManifoldCF is a multi-repository crawler framework, with multiple connectors,
+under incubation.
+
+For a complete description of the ManifoldCF project, team composition, source
+code repositories, and other details, please see the ManifoldCF web site at
+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".
+
+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.
+
+dist/doc/how-to-build-and-deploy.html
+  The Apache ManifoldCF documentation page describing building and deployment.
+
+framework
+  The sources for the Apache ManifoldCF framework.
+  
+connectors
+  The sources for the Apache ManifoldCF connectors.
+
+site
+  The sources for the Apache ManifoldCF documentation.
+  
+build.xml
+  The root ant build script for Apache ManifoldCF.
+
+
+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.
 
 Licensing
 ---------
@@ -54,6 +125,4 @@ Contact
   o For general information visit the main project site at
     http://incubator.apache.org/connectors
 
-  o For current status information visit the status page at
-    http://incubator.apache.org/connectors
 

Modified: incubator/lcf/trunk/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/build.xml?rev=1041763&r1=1041762&r2=1041763&view=diff
==============================================================================
--- incubator/lcf/trunk/build.xml (original)
+++ incubator/lcf/trunk/build.xml Fri Dec  3 10:27:12 2010
@@ -1404,6 +1404,8 @@ doc     - Build html site, under the 'di
 image   - Build release image, under the '.' directory (requires
           Apache Forrest)
 all     - Do it all (requires Apache Forrest)
+
+All targets requiring Apache Forrest also require Sun JDK 1.5.
       </echo>
     </target>