[pulsar] branch master updated: Update README.md with IDE setup for lombok (#3711)

[mm...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mmerli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new d84b687  Update README.md with IDE setup for lombok (#3711)
d84b687 is described below

commit d84b687c78973b2fdceb89f2a7f5fc07e40eaa9b
Author: Sijie Guo <gu...@gmail.com>
AuthorDate: Tue Mar 5 03:27:58 2019 +0800

    Update README.md with IDE setup for lombok (#3711)
---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index 4311b75..24f63e1 100644
--- a/README.md
+++ b/README.md
@@ -66,6 +66,34 @@ $ bin/pulsar standalone
 
 Check https://pulsar.apache.org for documentation and examples.
 
+## Setting up your IDE
+
+Apache Pulsar is using [lombok](https://projectlombok.org/) so you have to ensure your IDE setup with
+required plugins.
+
+### Intellij
+
+To configure annotation processing in IntelliJ:
+
+1. Open Annotation Processors Settings dialog box by going to
+   `Settings -> Build, Execution, Deployment -> Compiler -> Annotation Processors`.
+
+2. Select the following buttons:
+   1. "Enable annotation processing"
+   2. "Obtain processors from project classpath"
+   3. "Store generated sources relative to: Module content root"
+
+3. Set the generated source directories to be equal to the Maven directories:
+   1. Set "Production sources directory:" to "target/generated-sources/annotations".
+   2. Set "Test sources directory:" to "target/generated-test-sources/test-annotations".
+
+4. Click “OK”.
+
+### Eclipse
+
+Follow the instructions [here](https://howtodoinjava.com/automation/lombok-eclipse-installation-examples/)
+to configure your Eclipse setup.
+
 ## Build Pulsar docs
 
 Refer to the docs [README](site2/README.md).