svn commit: r1328011 - /incubator/stanbol/branches/0.9.0-incubating/README.md

[fc...@apache.org]

Author: fchrist
Date: Thu Apr 19 15:46:14 2012
New Revision: 1328011

URL: http://svn.apache.org/viewvc?rev=1328011&view=rev
Log:
STANBOL-270 Updated README to reflect the new deps package

Modified:
    incubator/stanbol/branches/0.9.0-incubating/README.md

Modified: incubator/stanbol/branches/0.9.0-incubating/README.md
URL: http://svn.apache.org/viewvc/incubator/stanbol/branches/0.9.0-incubating/README.md?rev=1328011&r1=1328010&r2=1328011&view=diff
==============================================================================
--- incubator/stanbol/branches/0.9.0-incubating/README.md (original)
+++ incubator/stanbol/branches/0.9.0-incubating/README.md Thu Apr 19 15:46:14 2012
@@ -23,8 +23,9 @@ semantic content management.
 
 ## Prepare Your Environment
 
-To build Apache Stanbol you need a JDK 1.6 and Maven 2.2.1 installed.
-You probably need
+To build Apache Stanbol you need a JDK 1.6 and Apache Maven 2.2.1
+installed. You probably need to set these Maven options to increase
+the available amount of memory for the Maven instance.
 
     $ export MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=128M"
 
@@ -34,22 +35,26 @@ Apache Stanbol has dependencies to third
 available via the Maven central repository, yet. Therefore, you have to
 install them manually into your local Maven repository.
 
-Third party dependencies not available via Maven central:
+Third party dependencies which are not available via Maven central:
+
   - OWL API version 3.2.3 from http://owlapi.sourceforge.net/
     License: Apache License, Version 2.0
 
 You can download the required dependencies for your version of Apache
-Stanbol by downloading them from:
+Stanbol by downloading the Apache Stanbol -deps package from:
 
 TODO
 
-Note, that this deps download is only provided for your convinience.
-It is not part of any official Apache Stanbol source release. You can also
-download the dependencies from the corresponding project websites.
-
-Once you have downloaded the deps package, you should extract it and
-execute the 'install.[sh|bat]' script. This will install the deps into
-your local Maven repository.
+*Note*, that this -deps package download is only provided for your convinience.
+It is not part of any official Apache Stanbol source release. You can
+also generate the -deps package by going to the /deps folder and following the
+instructions there. Third alternative would be to download the
+dependencies from their project websites and install them in the local
+Maven repository.
+
+If you have decided to download or generate the deps package, you
+should extract it and execute the included 'install.[sh|bat]' script.
+This will install the deps into your local Maven repository.
 
 ### The Build System
 
@@ -76,7 +81,7 @@ This builds Apache Stanbol including all
 default set of linked open data for the EntityHub. If you want to have a ready
 to use version of Apache Stanbol, this is the way to go.
 
-In the Stanbol source directory type
+In the Apache Stanbol source directory type
 
     $ mvn install
 
@@ -95,9 +100,10 @@ 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
+If Apache Stanbol is launched with a FactStore a folder named `factstore` is created
 in the current folder. This folder holds the FactStore database (Apache Derby).
 
+You can now start to explore Apache Stanbol and its services. Have fun!
 
 ## Importing the source code as Eclipse projects
 
@@ -105,7 +111,7 @@ Eclipse is the most popular IDE among St
 instructions to get you started with this IDE. For other IDEs / editors,
 please refer to their documentation and maven integration plugins.
 
-To generate the Eclipse project definition files, go to Stanbol source
+To generate the Eclipse project definition files, go to the Apache Stanbol source
 directory and type:
 
     $ mvn eclipse:eclipse
@@ -137,8 +143,8 @@ by pressing `Shift+Ctrl+F`.
 
 ## Debugging a Stanbol instance from Eclipse
 
-To debug a locally running Stanbol instance from eclipse, run the stanbol
-launcher with::
+To debug a locally running Apache Stanbol instance from eclipse, run the Apache
+Stanbol launcher with::
 
     $ java -Xdebug -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n \
            -jar org.apache.stanbol.some.launcher.0.9-SNAPSHOT.jar -p 8080
@@ -149,10 +155,10 @@ Java Application" and connect it to loca
 
 ## License check via the Apache's Release Audit Tool (RAT)
 
-To check for license headers within the source code Stanbol uses the RAT Maven
+To check for license headers within the source code, Apache 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
+For example to check the license headers in Apache Stanbol use
 
     $ mvn install -Prat
 
@@ -162,10 +168,10 @@ For example to check the licenses in the
 You should read [1,2] before doing any release related actions.
 
 To do a release test build, you have to activate the 'apache-release' profile.
-For building the framework plus signing the artifacts as it would be done during
+For building Apache Stanbol plus signing the artifacts as it would be done during
 a release you can use
 
-    $ mvn install -Pframework,apache-release
+    $ mvn install -Pstack,apache-release
 
 The 'apache-release' profile will be automatically activated when the Maven
 release plugin [3] is used. For doing official release you start with
@@ -184,4 +190,3 @@ release plugin [3] is used. For doing of
 
   - Please report bugs on the [Apache issue tracker](
     https://issues.apache.org/jira/browse/STANBOL)
-