svn commit: r1070835 - /incubator/stanbol/trunk/README.md

[og...@apache.org]

Author: ogrisel
Date: Tue Feb 15 11:05:39 2011
New Revision: 1070835

URL: http://svn.apache.org/viewvc?rev=1070835&view=rev
Log:
Better README.md

Modified:
    incubator/stanbol/trunk/README.md

Modified: incubator/stanbol/trunk/README.md
URL: http://svn.apache.org/viewvc/incubator/stanbol/trunk/README.md?rev=1070835&r1=1070834&r2=1070835&view=diff
==============================================================================
--- incubator/stanbol/trunk/README.md (original)
+++ incubator/stanbol/trunk/README.md Tue Feb 15 11:05:39 2011
@@ -20,17 +20,43 @@ Then in the Stanbol source directory typ
 
     $ mvn install
 
-If you want to skip the tests, add '-DskipTests' to the Maven command.
+If you want to skip the tests, add `-DskipTests` to the Maven command.
 
 
-## Creating Eclipse Projects
+## Importing the source code as Eclipse projects
 
-Go to Stanbol source directory and type
+Eclipse is the most popular IDE among Stanbol developers. Here are
+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
+directory and type:
 
     $ mvn eclipse:eclipse
 
 If you want to recreate already existing Eclipse projects, you have to delete
-the old ones first by using 'eclipse:clean'.
+the old ones first by using `eclipse:clean`.
+
+Then in Eclipse, right click on the `Project Explorer` panel and select
+your source folder from the following menu / import wizard:
+
+    > Import... > General > Import Existing Projects into Workspace
+
+You will also need to setup the build path variable `M2_REPO` pointing to
+`~/.m2/repository` (where `~` stands for the path to your home folder). To set
+up this variable go to:
+
+    > Window > Preferences > Java > Build Path > Classpath Variables > New...
+
+If you plan to contribute patches to the project, please ensure that your style
+follow the official sun java guidelines with 4 space indents (no tabs). To
+ensure that your files follow the guidelines you can import the formatter
+definitions avaiable in the `conventions/` folder:
+
+    > Window > Preferences > Java > Code Style > Formatter > Import...
+
+You can then apply the formatter to a selected area of a Java source code files
+by pressing `Shift+Ctrl+F`.
 
 
 ## Useful links