Complete build section of readme

diff --git a/README.md b/README.md
index a8436181d3e57601b2084b654de26a6af401115c..38852ca05f45238489f9a1f3bf239803f683ce58 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,12 +10,57 @@ Put your technical debt under control. For more information please see:
 
 This Git repository is core platform. Plugins are hosted in SonarCommunity and SonarSource organisations.
 
+### Checkout Sources
+
+If you have never used Git before, you need to do some setup first. Run the following commands so that GIT knows your name and email.
+
+    git config --global user.name "Your Name"
+    git config --global user.email "your@email.com"
+
+Setup line endings preferences:
+
+    # For Unix/Mac users
+    git config --global core.autocrlf input
+    git config --global core.safecrlf true
+
+    # For Windows users
+    git config --global core.autocrlf true
+    git config --global core.safecrlf true
+
+Get sources by executing:
+
+    git clone https://github.com/SonarSource/sonar.git
+    
+Committers must configure their SSH key (see GitHub documentation for Windows and Mac) and clone repository:
+
+    git clone git@github.com:SonarSource/sonar.git
+
 ### Build
 
+* Install JDK 6 or greater
 * Install Maven 3.0.5 or greater
 * Execute `mvn clean install`. To quickly build in development environment, the script `quick-build.sh` does not execute unit tests and compile GWT components for Firefox/Chrome only.
 * ZIP file of application is generated in sonar-application/target/
 
+### Edit Ruby Code
+
+The development mode is used to edit Ruby on Rails code. The application is automatically reloaded when Ruby files are saved. It avoids restarting the server. Changes are reloaded on the fly. Execute one of the following commands from the sonar-server/ directory to start server:
+
+    # for embedded database
+    sonar-server/derby-start.sh
+    
+    # or for other dbs
+    sonar-server/mysql-start.sh
+    sonar-server/postgresql-start.sh
+
+Then Ruby code can be directly edited from sonar-server/src/main/webapp/WEB-INF/app.
+
+### Debug Maven Analysis
+
+Debug Maven analysis by executing `mvnDebug sonar:sonar`. Then attach your IDE to the remote process (the listening port is 8000).
+
+Example in Intellij Idea : Run -> Edit configurations -> Add new configuration -> Remote -> port 8000.
+
 ## License
 
 Copyright 2008-2013 SonarSource.