Skip to content

Commit

Permalink
Update README.md with IDE setup for lombok (apache#3711)
Browse files Browse the repository at this point in the history
  • Loading branch information
sijie authored and merlimat committed Mar 4, 2019
1 parent 37a2fda commit d84b687
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit d84b687

Please sign in to comment.