From b0cb7d001336e883b9190333fcdf4b913a8fbff2 Mon Sep 17 00:00:00 2001 From: Emanuele Iannone <43892594+emaiannone@users.noreply.github.com> Date: Tue, 4 Feb 2020 14:54:07 +0100 Subject: [PATCH] Update README.md wiith installation details --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b0a91b7..445d728 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,21 @@ aDoctor is the outcome of the research conducted in the Software Engineering Lab ## Installation ad execution -Follow these steps to install and launch the plugin: +### Install from Jetbrains Plugin Repository + +Follow these steps to install the plugin in Android Studio for production use: + +1. Open Android Studio +2. Go into *File>Settings...>Plugins>Marketplace* +3. Type "aDoctor" +4. Install it +5. Restart Android Studio +6. Open the Android project you wish to analyze +7. Go to *Refactor>ADoctor* to launch the plugin + +### Install from disk + +Follow these steps to install the plugin in Android Studio for production use: 1. Clone the repository 2. Open the project with IntelliJ IDEA @@ -26,4 +40,15 @@ Follow these steps to install and launch the plugin: 9. Select the zip file 10. Restart Android Studio 11. Open the Android project you wish to analyze -12. Go to *Refactor>ADoctor* to launch the plugin \ No newline at end of file +12. Go to *Refactor>ADoctor* to launch the plugin + +### Get source code and run in sandbox + +Follow these steps to build the source code and run the plugin in a sandbox: + +1. Clone the repository +2. Open the project with IntelliJ IDEA +3. Build the project (with the IDE) just to be sure everything is alright. Ensure you have IntelliJ Platform SDK installed +4. Run the project (with the IDE) though the run configuration *Run aDoctor*: this will run IntelliJ IDEA sandbox +5. Open the project you wish to analyze +6. Go to *Refactor>ADoctor* to launch the plugin