incubator-ctakes-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r1399710 - /incubator/ctakes/site/trunk/content/ctakes/source.mdtext
Date Thu, 18 Oct 2012 16:00:29 GMT
Author: chenpei
Date: Thu Oct 18 16:00:28 2012
New Revision: 1399710

Drafting the developer building from source instructions


Modified: incubator/ctakes/site/trunk/content/ctakes/source.mdtext
--- incubator/ctakes/site/trunk/content/ctakes/source.mdtext (original)
+++ incubator/ctakes/site/trunk/content/ctakes/source.mdtext Thu Oct 18 16:00:28 2012
@@ -1,4 +1,4 @@
-Title: Source Control
+Title: Apache cTAKES - Building and Running 
 Notice:    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
@@ -15,24 +15,33 @@ Notice:    Licensed to the Apache Softwa
            KIND, either express or implied.  See the License for the
            specific language governing permissions and limitations
            under the License.
+## Viewing the code on the web via ViewVC
-We use [Apache Subversion][1] for version control. You can [browse our 
-repository][2] in your web browser.
-## Getting the source code
-    svn co ctakes
+You can browse [our repository][2] in your web browser.
 ## Building and Running
-Coming soon
+### Using Eclipse IDE
+*Requirements*: Eclipse IDE 4.2+, Java JDK 1.6+, subversive plugin (or svn equivalent with
appropriate svn team provider connectors), m2e plugin (or mvn equivalent)
-### Requirements:
+ 1. Import Project > Maven > Checkout Maven Project from SCM
+ 2. Use: svn: [][2]
+ 3. Select all projects.  
+ 4. Wait until Eclipse downloads and builds all of your projects (it may take up to 30 mins
depending on the machine).  The 
+various build helpers should run jcasgen and builds the projects for you (there shouldn't
be a need to run mvn install, etc.)
+ 5. [Optional] If you would like to launch the UIMA CVD/CPE GUI, run ctakes-clinical-pipeline/resources/launch/UIMA_{CVD/CPE}_GUI--clinical_documents_
+### Using Command Line
+*Requirements*: SVN, Java JDK 1.6+, Maven 3.0+
+ 1. svn co [][2] ctakes
+ 2. mvn clean compile package
+ 3. [Optional] If you would like to launch the UIMA CVD/CPE GUI, run $ MAVEN_OPTS="-Xmx10"
mvn -PrunCVD compile
-Coming soon
+Notes:  If you run mvn package, it will generate a binary distribution in /ctakes-distribution/target/ctakes-{release}-bin.tar.gz/zip.
 For further information see the [Apache Source Code Repository][3] page.
\ No newline at end of file

View raw message