Skip to content
This repository has been archived by the owner on Oct 5, 2021. It is now read-only.

Commit

Permalink
Merge pull request #161 from Shan1024/update-readme
Browse files Browse the repository at this point in the history
Update ReadMe with the latest build process
  • Loading branch information
sameerajayasoma authored Mar 1, 2017
2 parents ea6600a + 3f2c8a0 commit c0d6b89
Show file tree
Hide file tree
Showing 10 changed files with 41 additions and 17 deletions.
18 changes: 3 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,15 @@
```
git clone --recursive https://github.com/ballerinalang/plugin-intellij.git
```
2. Make sure that the bundled **Plugin DevKit** plugin is enabled in IDEA.
3. Open the project in IDEA.
4. Configure a common JDK and an IntelliJ Platform SDK.

This can be done in **File -> Project Structure -> SDKs**.

For the IntelliJ Platform SDK, you may need to specify the directory containing the installed version of IntelliJ IDEA. By default it should offer the directory of the currently running version of IntelliJ IDEA.
5. Build the project using **Build -> Build Project**.
6. Run **Build -> Prepare Plugin Module 'Ballerina-intellij-plugin' For Deployment**.
7. In the project root directory, **Ballerina-intellij-plugin.zip** will be created.
2. Install latest version of [Gradle](https://gradle.org/) if you don't have it installed already.
3. Navigate into the cloned repository and run `gradle buildPlugin`.
4. In the **build/distributions** directory, **Ballerina-Intellij-Plugin.zip** will be created.

## Installing the plugin to IDEA
1. Go to **File -> Settings** and select **Plugins**.
2. Click **Install plugin from disc** button and select the deployed **plugin zip** file. Please make sure to install the Zip file, not the extracted Jar files. This zip contains an additional library as well. Without this library, the plugin will not work properly.
3. Restart IDEA.

## Running the plugin without building
1. Follow the first 4 steps in the [Building from the source](#building-from-the-source) section.
2. Go to **Run -> Edit Configurations**.
3. Add a new **plugin** configuration.
4. Now you can run or debug the plugin directly from the IDEA.

## Getting started

Expand Down
5 changes: 3 additions & 2 deletions getting-started/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
### Getting started
# Getting started

1) [Setting up Ballerina SDK.](setting-up-ballerina-sdk)
1. [Running the plugin using IDEA.](running-the-plugin)
2. [Setting up Ballerina SDK.](setting-up-ballerina-sdk)
35 changes: 35 additions & 0 deletions getting-started/running-the-plugin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## Running the plugin using IDEA

1. Go to **File -> Open** and open the cloned repository using IntelliJ IDEA.

![alt text](images/Figure-1.png)

2. **Import Project from Gradle** settings window will be shown. Select the **Gradle Home** path and select **OK**.

![alt text](images/Figure-2.png)

3. From the **Gradle projects** tool window, run `runIde` task. This will build the plugin and a new IDEA instance will be started with the plugin installed.

If the **Gradle projects** window is not visible, you can use **View -> Tool Windows -> Gradle** to go to the Gradle projects tool window.

![alt text](images/Figure-3.png)

4. In addition to the above method, you can also add a **Gradle configuration** to **Run** or **Debug** the plugin.

* Go to **Run -> Edit Configurations**.

* Add a new Gradle Configuration.

![alt text](images/Figure-4.png)

* Select the **plugin-intellij** project as the **Gradle project**.

![alt text](images/Figure-5.png)

* Add `runIde` to the **Tasks**.

![alt text](images/Figure-6.png)

* Now you can **Run** or **Debug** the plugin using the created Gradle configuration very easily.

![alt text](images/Figure-7.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 c0d6b89

Please sign in to comment.