You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by og...@apache.org on 2011/02/09 19:06:20 UTC

svn commit: r1069005 - in /incubator/stanbol/trunk: README.md README.txt

Author: ogrisel
Date: Wed Feb  9 18:06:19 2011
New Revision: 1069005

URL: http://svn.apache.org/viewvc?rev=1069005&view=rev
Log:
markdown formatting for the main README for better looking github home

Added:
    incubator/stanbol/trunk/README.md
      - copied, changed from r1068991, incubator/stanbol/trunk/README.txt
Removed:
    incubator/stanbol/trunk/README.txt

Copied: incubator/stanbol/trunk/README.md (from r1068991, incubator/stanbol/trunk/README.txt)
URL: http://svn.apache.org/viewvc/incubator/stanbol/trunk/README.md?p2=incubator/stanbol/trunk/README.md&p1=incubator/stanbol/trunk/README.txt&r1=1068991&r2=1069005&rev=1069005&view=diff
==============================================================================
--- incubator/stanbol/trunk/README.txt (original)
+++ incubator/stanbol/trunk/README.md Wed Feb  9 18:06:19 2011
@@ -1,51 +1,52 @@
-                      Welcome to Apache Stanbol
-                     ---------------------------
+= Apache Stanbol
 
-Building Stanbol:
------------------
+Apache Stanbol is a modular set of components and HTTP services for
+semantic content management.
+
+
+== Building Stanbol
 
 To build Stanbol you need a JDK 1.6 and Maven 2.2.1 installed. You probably
 need
 
-  $ export MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=128M"
+    $ export MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=128M"
 
 Before you can build Stanbol you need to install a few artifacts to your local
 Maven repository. This step is needed at the moment because these artifacts are
 not available via any public Maven repository. Please go to the Stanbol source
 directory and type the following commands:
 
-  $ mvn install:install-file -Dfile=kres/lib/owlapi-3.0.0.jar \
-       -DgroupId=owlapi -DartifactId=owlapi -Dversion=3.0.0 -Dpackaging=jar
+    $ mvn install:install-file -Dfile=kres/lib/owlapi-3.0.0.jar \
+         -DgroupId=owlapi -DartifactId=owlapi -Dversion=3.0.0 -Dpackaging=jar
 
-  $ mvn install:install-file -Dfile=kres/lib/HermiT.jar \
-       -DgroupId=hermit -DartifactId=hermit -Dversion=1.2.4 -Dpackaging=jar
+    $ mvn install:install-file -Dfile=kres/lib/HermiT.jar \
+         -DgroupId=hermit -DartifactId=hermit -Dversion=1.2.4 -Dpackaging=jar
 
-  $ mvn install:install-file -Dfile=kres/lib/owl-link-1.0.2.jar \
-       -DgroupId=owl-link -DartifactId=owl-link -Dversion=1.0.2 -Dpackaging=jar
+    $ mvn install:install-file -Dfile=kres/lib/owl-link-1.0.2.jar \
+         -DgroupId=owl-link -DartifactId=owl-link -Dversion=1.0.2 -Dpackaging=jar
 
 Then again in the Stanbol source directory type
 
-  $ mvn install
+    $ mvn install
 
 If you want to skip the tests, add '-DskipTests' to the Maven command.
 
 
-Creating Eclipse Projects:
---------------------------
+== Creating Eclipse Projects
 
 Go to Stanbol source directory and type
 
-  $ mvn eclipse:eclipse
+    $ mvn eclipse:eclipse
 
 If you want to recreate already existing Eclipse projects, you have to delete
 the old ones first by using 'eclipse:clean'.
 
 
-Issue Tracking:
----------------
+== Useful links
 
-Please report bugs at
-  
-  https://issues.apache.org/jira/browse/STANBOL
+  - Documentation will be published and mailing lists info at:
+    http://incubator.apache.org/stanbol/
 
+  - Please report bugs at:
+    https://issues.apache.org/jira/browse/STANBOL