azkaban-aplcache

Update readme.MD (#1080) - Added Developer Guide section -

5/14/2017 6:14:53 PM

Changes

README.md 52(+34 -18)

Details

README.md 52(+34 -18)

diff --git a/README.md b/README.md
index 04afd77..219e8da 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,48 @@
-Azkaban 3 [![Build Status](http://img.shields.io/travis/azkaban/azkaban.svg?style=flat)](https://travis-ci.org/azkaban/azkaban)
-========
+# Azkaban [![Build Status](http://img.shields.io/travis/azkaban/azkaban.svg?style=flat)](https://travis-ci.org/azkaban/azkaban)
 
 [![Join the chat at https://gitter.im/azkaban-workflow-engine/Lobby](https://badges.gitter.im/azkaban-workflow-engine/Lobby.svg)](https://gitter.im/azkaban-workflow-engine/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-Building from Source
---------------------
+## Building Azkaban
+Azkaban builds use Gradle and requires Java 8 or higher.
 
-To build Azkaban packages from source, run:
+The following set of commands run on *nix platforms like Linux, OS X.
 
 ```
-./gradlew distTar
-```
+# Build Azkaban
+./gradlew build
 
-The above command builds all Azkaban packages and packages them into GZipped Tar archives. To build Zip archives, run:
+# Clean the build
+./gradlew clean
 
-```
-./gradlew distZip
-```
+# Build and install distributions
+./gradlew installDist
 
-If not building for the first time, it's good to clean first:
+# Run tests
+./gradlew test
 
+# Build without running tests
+./gradlew build -x test
 ```
-./gradlew clean
-```
 
-Documentation
--------------
+## Documentation
+Documentation is available at [azkaban.github.io](http://azkaban.github.io). 
+The source code for the documentation is in the [gh-pages](https://github.com/azkaban/azkaban/tree/gh-pages) branch.
+
+For help, please visit the [Azkaban Google Group](https://groups.google.com/forum/?fromgroups#!forum/azkaban-dev).
+
+## Developer Guide
+We recommend using [IntelliJ IDEA](https://www.jetbrains.com/idea/). Azkaban is a standard [Gradle](https://gradle.org/) 
+project. You can import it into your IDE using the `build.gradle` file in the root directory. For IntelliJ, choose Open 
+Project from the Quick Start box or choose Open from the File menu and select the root `build.gradle` file.
+
+### Code Style
+Azkaban follows Google code style. The template file, `intellij-java-google-style.xml`, can be found in the root 
+directory.
+
+#### IntelliJ IDEA 2017.1 on Mac OS X
+To install, copy `intellij-java-google-style.xml` into `~/Library/Preferences/IntelliJIdea2017.1/codestyles`
 
-For Azkaban documentation, please go to [Azkaban Project Site](http://azkaban.github.io). The source code for the documentation is in the [gh-pages branch](https://github.com/azkaban/azkaban/tree/gh-pages).
+#### IntelliJ IDEA 2017.1 on Linux
+To install, copy `intellij-java-google-style.xml` into `$HOME/.IdeaIC2017.1/config/codestyles`
 
-For help, please visit the Azkaban Google Group: [Azkaban Group](https://groups.google.com/forum/?fromgroups#!forum/azkaban-dev)
+After that, you should be able to set up the code style from `Preferences > Editor > Code Style > Scheme`