Skip to content

Commit

Permalink
README.md: Add usage and update install details
Browse files Browse the repository at this point in the history
  • Loading branch information
arafsheikh committed Jan 3, 2017
1 parent 892a3a3 commit f991ca6
Showing 1 changed file with 45 additions and 8 deletions.
53 changes: 45 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@
This package offers a plugin for the Eclipse to use the code analysis software [coala](https://github.com/coala-analyzer/coala) inside the IDE.

## Installation
1. Install [coala](https://github.com/coala-analyzer/coala).
2. In Eclipse go to Help -> Install New Software -> Add
1. In location enter https://github.com/coala-analyzer/coala-eclipse/raw/master/export
2. In name enter coala.
3. Press ok.
3. Uncheck "group items by category".
4. Select coala.
5. Click next and accept terms.

<a href="http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=3100683" class="drag" title="Drag to your running Eclipse workspace."><img class="img-responsive" src="https://marketplace.eclipse.org/sites/all/themes/solstice/public/images/marketplace/btn-install.png" alt="Drag to your running Eclipse workspace." /></a>

Drag the above button into your running Eclipse workspace and accept the terms to install.

*If you're unable to view the button install the plug-in from the [Eclipse Marketplace](https://marketplace.eclipse.org/content/coala-eclipse-plug).*

### Build developmental version
```text
Expand All @@ -24,3 +22,42 @@ mvn clean verify
2. Select coala.
3. Click uninstall.

## Using the plug-in

*The plug-in requires the coala binaries to be present on your system. If you haven't already installed coala you can read the installation instructions [here](https://github.com/coala/coala#installation).*

There are two ways in which you can run coala from the Eclipse plug-in:
* Using a `coafile`.
* Manually selecting a bear to run the analysis with.

### Running coala using a [`coafile`](http://coala.readthedocs.io/en/latest/Users/coafile.html)

1. Fire up Eclipse and open a file that you want to run the analysis on.

2. Make sure you have configured the `coafile`. Learn more about that [here](http://coala.readthedocs.io/en/latest/Users/coafile.html).

3. Click the `coala` button on the tool-bar.

4. The plug-in will then run the analysis and display the results in the `Problems` pane.

### Running coala by manually selecting the bear of your choice

1. Fire up Eclipse and open a file that you want to run the analysis on.

2. Right click anywhere inside the editor window to open the context menu.

3. In the `Run coala with` push menu, select the the bear you wish to run.

4. The plug-in will then run the analysis and display the results in the `Problems` pane.

### Fixing issues returned after analysis

1. After the analysis is complete and the issues are visible in the `Problems` pane, right-click an issue and select the `Quick Fix` option (*Ctrl +1* keyboard shortcut).

2. In the `Quick Fix` dialog, select the fix that you want to apply and click `Finish`.

3. The issue will be fixed and no longer visible in the `Problems` pane.

## License

![AGPL](https://img.shields.io/github/license/coala/coala.svg)

0 comments on commit f991ca6

Please sign in to comment.