xdocs/dev-quick.xml - uima-site - Git at Google

 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
 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

   https://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.
 -->
 <document>

 <properties>
 <title>Quick Start for working with Source Code</title>
 <author email="dev@uima.apache.org">
  Apache UIMA Documentation Team</author>
 </properties>

 <body>
 <section name="Do the one-time-setup">
 <p>To work with the source code, start by doing the
 <a href="one-time-setup.html">one-time setups</a>.
 </p>
 </section>

 <section name="Checkout and Build UIMA SDK">
 <p>To build all of the Apache UIMA Java SDK
 (including the docbooks and the binary assembly) and install these artifacts
 to your local maven repository, do the following commands.  We'll assume
 you want to do this work in a local disk directory on your build machine.
 </p>

 <p>First, as an example, create the local build directory by using whatever your operating system's
   commands are for creating this.  For instance, in Windows, you might pick "myWorkingCopy"
   as the name of your local build directory, and create it at the top level, using the command:
   </p>

 <ul>
   <lil><code>mkdir \myWorkingCopy</code></lil>
 </ul>

 <p>UIMA has several projects.  The main, core project, is the Java SDK.  This is named "uimaj" -
 the last letter, "j" stands for "Java".  Here are sample commands that check out the "trunk"
 (most current) version
 into a subdirectory of <code>\myWorkingCopy</code>
 and build it using:
 <ul>
 <li>cd \myWorkingCopy</li>
 <li><code>svn checkout https://svn.apache.org/repos/asf/uima/uimaj/trunk uimaj</code></li>
 <li><code>cd uimaj</code></li>
 <li><code>mvn install</code></li>
 </ul>
 </p>
 <p class="note">Note: if you're using Linux or MacOS,
 change the directory separator character to a forward slash ( "/" ).</p>

 <p class="note">Note: to build a particular release. instead of the most current (and possibly, not working)
 version under development, replace "trunk" with "tags/" + the svn name
 of that release,
 such as "tags/uimaj-2.9.0".</p>

 <p>If you're looking for the lib containing all the built Jars, <code>cd \myWorkingCopy\uimaj\target</code>
 and unzip/untar the binary distribution artifact, named something like
 <code>uimaj-[version]-bin.zip or uimaj-[version]-bin.tar.gz</code>.
 Then, look inside the unpacked result for a lib directory - it will have the Jars that were built.
 </p>
 </section>

 <section name="Checkout and Build an Addons (Sandbox) project">
 <p>
 <ul>
 <li><code>cd \myWorkingCopy</code></li>
 <li><code>svn checkout https://svn.apache.org/repos/asf/uima/addons/trunk addons</code></li>
 <li><code>cd addons</code></li>
 <li><code>mvn install</code></li>
 </ul>
 </p>

 <p>To check out just one of the addons and build it, say, the WhitespaceTokenizer, do:<a></a>
 <ul>
 <li><code>cd \myWorkingCopy</code></li>
 <li><code>svn checkout https://svn.apache.org/repos/asf/uima/addons/trunk/WhitespaceTokenizer whitespaceTokenizer</code></li>
 <li><code>cd whitespaceTokenizer</code></li>
 <li><code>mvn install</code></li>
 </ul>
 </p>
 </section>
 </body>
 </document>
	<?xml version="1.0" encoding="ISO-8859-1"?>
	<!--
	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

	https://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.
	-->
	<document>

	<properties>
	<title>Quick Start for working with Source Code</title>
	<author email="dev@uima.apache.org">
	Apache UIMA Documentation Team</author>
	</properties>

	<body>
	<section name="Do the one-time-setup">
	<p>To work with the source code, start by doing the
	<a href="one-time-setup.html">one-time setups</a>.
	</p>
	</section>

	<section name="Checkout and Build UIMA SDK">
	<p>To build all of the Apache UIMA Java SDK
	(including the docbooks and the binary assembly) and install these artifacts
	to your local maven repository, do the following commands. We'll assume
	you want to do this work in a local disk directory on your build machine.
	</p>

	<p>First, as an example, create the local build directory by using whatever your operating system's
	commands are for creating this. For instance, in Windows, you might pick "myWorkingCopy"
	as the name of your local build directory, and create it at the top level, using the command:
	</p>

	<ul>
	<lil><code>mkdir \myWorkingCopy</code></lil>
	</ul>

	<p>UIMA has several projects. The main, core project, is the Java SDK. This is named "uimaj" -
	the last letter, "j" stands for "Java". Here are sample commands that check out the "trunk"
	(most current) version
	into a subdirectory of <code>\myWorkingCopy</code>
	and build it using:
	<ul>
	<li>cd \myWorkingCopy</li>
	<li><code>svn checkout https://svn.apache.org/repos/asf/uima/uimaj/trunk uimaj</code></li>
	<li><code>cd uimaj</code></li>
	<li><code>mvn install</code></li>
	</ul>
	</p>
	<p class="note">Note: if you're using Linux or MacOS,
	change the directory separator character to a forward slash ( "/" ).</p>

	<p class="note">Note: to build a particular release. instead of the most current (and possibly, not working)
	version under development, replace "trunk" with "tags/" + the svn name
	of that release,
	such as "tags/uimaj-2.9.0".</p>

	<p>If you're looking for the lib containing all the built Jars, <code>cd \myWorkingCopy\uimaj\target</code>
	and unzip/untar the binary distribution artifact, named something like
	<code>uimaj-[version]-bin.zip or uimaj-[version]-bin.tar.gz</code>.
	Then, look inside the unpacked result for a lib directory - it will have the Jars that were built.
	</p>
	</section>

	<section name="Checkout and Build an Addons (Sandbox) project">
	<p>
	<ul>
	<li><code>cd \myWorkingCopy</code></li>
	<li><code>svn checkout https://svn.apache.org/repos/asf/uima/addons/trunk addons</code></li>
	<li><code>cd addons</code></li>
	<li><code>mvn install</code></li>
	</ul>
	</p>

	<p>To check out just one of the addons and build it, say, the WhitespaceTokenizer, do:<a></a>
	<ul>
	<li><code>cd \myWorkingCopy</code></li>
	<li><code>svn checkout https://svn.apache.org/repos/asf/uima/addons/trunk/WhitespaceTokenizer whitespaceTokenizer</code></li>
	<li><code>cd whitespaceTokenizer</code></li>
	<li><code>mvn install</code></li>
	</ul>
	</p>
	</section>
	</body>
	</document>