Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
emadpres committed Jan 9, 2019
1 parent f244edf commit 3b9ece2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# ADANA
*ADANA* is a novel approach to automatically generate and inject comments that describe a given piece of source code. This repository accommodate the ADANA Android Studio/IntelliJ IDE plugin. After installing the plugin on the IDE, select a piece of code, right click and select <em>Document Selected Code</em>
[*ADANA*](http://ADANA.si.usi.ch/) is a novel approach to automatically generate and inject comments that describe a given piece of source code. This repository accommodate the ADANA Android Studio/IntelliJ IDE plugin. After installing the plugin on the IDE, select a piece of code, right click and select <em>Document Selected Code</em>.

<img src="http://adana.si.usi.ch/img/gui.png" alt="Plugin Screenshot" width="700">


## Installation
### Binary
To install using pre-built binary, first download [the latest release](https://github.com/Emadpres/ADANA_Plugin/releases/latest). Then, go to Android Studio > Preference > Plugin > install plugin from Hard and select the downloaded file.
To install using pre-built binary, first download [the latest release](https://github.com/Emadpres/ADANA/releases/latest). Then, go to Android Studio > Preference > Plugin > install plugin from Hard and select the downloaded file.

### Source code
First clone the project. Follow the [Setting Up a Development Environment](http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started.html) guideline to setup the IntelliJ IDE for plugin development. Now you should be able to compile the project (requires Java 1.8+) and run it. In the end, deploy the project by following the [Deploying a Plugin](http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/deploying_plugin.html) tutorial.
Expand Down
Binary file added screens/gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3b9ece2

Please sign in to comment.