You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ctakes.apache.org by bu...@apache.org on 2012/11/07 16:18:39 UTC

svn commit: r837575 - in /websites/staging/ctakes/trunk/content: ./ ctakes/developerguide.html

Author: buildbot
Date: Wed Nov  7 15:18:39 2012
New Revision: 837575

Log:
Staging update by buildbot for ctakes

Added:
    websites/staging/ctakes/trunk/content/ctakes/developerguide.html
Modified:
    websites/staging/ctakes/trunk/content/   (props changed)

Propchange: websites/staging/ctakes/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Nov  7 15:18:39 2012
@@ -1 +1 @@
-1406670
+1406671

Added: websites/staging/ctakes/trunk/content/ctakes/developerguide.html
==============================================================================
--- websites/staging/ctakes/trunk/content/ctakes/developerguide.html (added)
+++ websites/staging/ctakes/trunk/content/ctakes/developerguide.html Wed Nov  7 15:18:39 2012
@@ -0,0 +1,30 @@
+## Viewing the code on the web via ViewVC
+
+You can browse [our repository][2] in your web browser.
+
+## Building and Running
+
+### 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)
+
+ 1. Import Project > Maven > Checkout Maven Project from SCM
+ 2. Use: svn: [https://svn.apache.org/repos/asf/incubator/ctakes/trunk][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_
+pipeline.launch.
+
+### Using Command Line
+*Requirements*: SVN, Java JDK 1.6+, Maven 3.0+
+
+ 1. svn co [https://svn.apache.org/repos/asf/incubator/ctakes/trunk][2] ctakes
+ 2. mvn clean compile package
+ 3. [Optional] If you would like to launch the UIMA CVD/CPE GUI, run $ MAVEN_OPTS="-Xmx1g" mvn -PrunCVD compile
+
+Notes:  If you run the 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.
+
+[2]: http://svn.apache.org/viewvc/incubator/ctakes/trunk
+[3]: http://www.apache.org/dev/version-control.html
\ No newline at end of file