Author: fchrist
Date: Thu Jul 21 08:44:09 2011
New Revision: 1149078
URL: http://svn.apache.org/viewvc?rev=1149078&view=rev
Log:
Updated README and documented the available build profiles
Modified:
incubator/stanbol/trunk/README.md
Modified: incubator/stanbol/trunk/README.md
URL:
http://svn.apache.org/viewvc/incubator/stanbol/trunk/README.md?rev=1149078&r1=1149077&r2=1149078&view=diff
==============================================================================
--- incubator/stanbol/trunk/README.md (original)
+++ incubator/stanbol/trunk/README.md Thu Jul 21 08:44:09 2011
@@ -3,7 +3,6 @@
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
@@ -11,24 +10,36 @@ need
$ export MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=128M"
-The Kres build is currently disabled by default.
+The Stanbol build system consists of the following profiles:
-If you want to include Kres in your build, activate the kres Maven profile
-(add -P kres to the mvn command line).
+ - 'stack' (default) - to build the Stanbol Stack
+ - 'framework' - to build the Stanbol Framework only
+ - 'kres' - to build additional Reasoning components that
+ are not yet in a stable state
-Then in the Stanbol source directory type
+The 'stack' profile is activated by default. If you whish to activate another
+profile use the Maven -P command line switch.
- $ mvn install
+If you want to skip the tests for any build profile, add `-DskipTests` to the
+Maven command.
+
+
+## Building the Stanbol Stack
-If you want to skip the tests, add `-DskipTests` to the Maven command.
+This builds the Stanbol Framework plus available Enhancement Engines and a
+default set of linked open data for the EntityHub. If you want to have a ready
+to use version of Stanbol, this is the way to go.
+In the Stanbol source directory type
-## Launching the Stanbol server
+ $ mvn install
+
+### Launching the Stanbol server
The recommended lanchers are packaged under the `launchers/` folder. For
instance:
- $ java -Xmx1g -jar
launchers/full/target/org.apache.stanbol.launchers.full-0.9-SNAPSHOT.jar
+ $ java -Xmx1g -jar
launchers/full/target/org.apache.stanbol.launchers.full-0.9.0-incubating-SNAPSHOT.jar
Your instance is then available on <http://localhost:8080>. You can change the
default port number by passing a `-p 9090` options to the commandline launcher.
@@ -37,6 +48,19 @@ Upon first startup, a folder named `slin
This folder will hold the files for any database used by Stanbol, deployment
configuration and logs.
+If Stanbol is launched with a FactStore a folder named `factstore` is created
+in the current folder. This folder holds the FactStore database (Apache Derby).
+
+
+## Building the Stanbol Framework only
+
+This build is used to build the Stanbol Framework only. That is without any
+Enhancement Engines or prepared linked open data indexes for the EntityHub.
+
+In the Stanbol source directory type
+
+ $ mvn install -Pframework
+
## Preloading the Entity Hub cache with a DBpedia index
@@ -90,6 +114,20 @@ launcher with::
In eclipse, you can then create a new "Debug Configuration" with type "Remote
Java Application" and connect it to localhost on port 8787.
+## License check via the Apache's Release Audit Tool (RAT)
+
+To check for license headers within the source code Stanbol uses the RAT Maven
+plugin [1]. You can activate a 'rat:check' by using the 'rat' Maven profile.
+
+For example to check the licenses in the Stanbol Framework use
+
+ $ mvn install -Pframework,rat
+
+*NOTE*: We use the RAT plugin version 0.8-SNAPSHOT which is not available yet
+via any public Maven repository. To be able to use RAT you will have to check
+out the sources from [1] and build it locally.
+
+[1] http://incubator.apache.org/rat/
## Useful links
