forked from ballerina-platform/ballerina-lang
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
24 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,35 @@ | ||
## Ballerina plugin for IntelliJ IDEA | ||
# Ballerina plugin for IntelliJ IDEA | ||
|
||
### Building from the source | ||
## Building from the source | ||
|
||
1) Clone the repository. | ||
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. | ||
1. Clone the repository. | ||
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-idea-plugin' For Deployment**. | ||
7) In the project root directory, **ballerina-idea-plugin.jar** 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 jar file. | ||
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. | ||
|
||
### How to contribute | ||
5. Build the project using **Build -> Build Project**. | ||
6. Run **Build -> Prepare Plugin Module 'ballerina-idea-plugin' For Deployment**. | ||
7. In the project root directory, **ballerina-idea-plugin.jar** 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 jar file. | ||
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. | ||
|
||
## How to contribute | ||
Pull requests are highly encouraged and we recommend you to create a GitHub issue to discuss the issue or feature that you are contributing to. | ||
|
||
### License | ||
## License | ||
Ballerina IDEA plugin is available under the Apache 2.0 License. | ||
|
||
### Copyright | ||
## Copyright | ||
Copyright (c) 2017, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. |