svn commit: r524428 - /incubator/tika/trunk/README.txt

[ju...@apache.org]

Author: jukka
Date: Sat Mar 31 06:47:24 2007
New Revision: 524428

URL: http://svn.apache.org/viewvc?view=rev&rev=524428
Log:
TIKA-4: Added brief Maven build instructions and some other project documentation.

Modified:
    incubator/tika/trunk/README.txt

Modified: incubator/tika/trunk/README.txt
URL: http://svn.apache.org/viewvc/incubator/tika/trunk/README.txt?view=diff&rev=524428&r1=524427&r2=524428
==============================================================================
--- incubator/tika/trunk/README.txt (original)
+++ incubator/tika/trunk/README.txt Sat Mar 31 06:47:24 2007
@@ -2,6 +2,10 @@
 Welcome to Apache Tika  <http://incubator.apache.org/tika/>
 ===========================================================
 
+Apache Tika is a toolkit for detecting and extracting metadata and
+structured text content from various documents using existing parser
+libraries. 
+
 Apache Tika is an effort undergoing incubation at The Apache Software
 Foundation (ASF), sponsored by the Apache Lucene PMC. Incubation is
 required of all newly accepted projects until a further review indicates
@@ -33,3 +37,33 @@
 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.
+
+Building Tika
+=============
+
+You can build the Tika sources using the Maven 2 build system. Execute the
+following command in the Tika source directory to build the sources and
+to install the resulting jar artifact in your local Maven repository:
+
+    mvn install
+
+See the Maven web site at http://maven.apache.org/ for more instructions
+and the latest Maven downloads. 
+
+Mailing Lists
+=============
+
+Discussion about the Tika project takes place on the development mailing
+list tika-dev@incubator.apache.org. The list is open to anyone and
+publicly archived. You can subscribe the mailing list by sending a
+message to tika-dev-subscribe@incubator.apache.org, and unsubscribe by
+sending a message to tika-dev-unsubscribe@incubator.apache.org. To receive
+more instructions, send a message to tika-dev-help@incubator.apache.org.
+
+Issue Tracker
+=============
+
+If you encounter errors in Tika or want to suggest an improvement or
+a new feature, please visit the Tika issue tracker at
+https://issues.apache.org/jira/browse/TIKA. There you can also find the
+latest information on known issues and recent bug fixes and enhancements.