setting_up_environment.md: clarifications

This commit is contained in:
Karol Lewandowski 2022-01-27 13:01:08 +01:00
parent 379ca14241
commit 50728ce422

View File

@ -9,20 +9,19 @@
### Preliminary Steps
Use the following checklist to ensure that you are ready to develop your custom plugins.
- **Get IntelliJ IDEA CE source code** on your local computer.
Getting IntelliJ IDEA CE source code is not a requirement for plugin development, but having it makes debugging your plugins much more straightforward.
For detailed instructions, refer to the _Getting IntelliJ IDEA Community Edition Source Code_ section of [Check Out And Build Community Edition](upsource:///README.md).
Note that building IntelliJ IDEA CE from source code is not required for plugin development.
- **Plugin DevKit** plugin must be [enabled in IntelliJ IDEA](https://www.jetbrains.com/help/idea/managing-plugins.html).
- **IntelliJ Platform SDK** must be configured for your IDEA project.
For more information, see below.
- (_Optional_) **Get IntelliJ IDEA CE source code** on your local computer.
Getting IntelliJ IDEA CE source code is not a requirement for plugin development, but having it makes debugging your plugins much more straightforward.
For detailed instructions, refer to the _Getting IntelliJ IDEA Community Edition Source Code_ section of [Check Out And Build Community Edition](upsource:///README.md).
Note that building IntelliJ IDEA CE from source code is not required for plugin development.
### Configuring IntelliJ Platform SDK
To set up your plugin development environment:
* Setup required Java SDK.
* Set up a required Java SDK.
See the _IntelliJ Build Configuration_ section of [Check Out And Build Community Edition](upsource:///README.md) for instructions about creating **1.8** (**11** when targeting 2020.3 or later) Java SDK.
> Do not use a more recent Java version than the one specified.
@ -33,15 +32,16 @@ To set up your plugin development environment:
<br/>
<br/>
* Specify the installation folder of the *IntelliJ IDEA Community Edition* as the home directory (on Mac, select application icon in _/Applications/_).
You can use the installation package built from sources or download it from the [Download IntelliJ IDEA page](https://www.jetbrains.com/idea/download/).
> You may use IntelliJ IDEA Ultimate as an alternative, but debugging the core code will only work with the *Community Edition*.
![Set Home Directory](set_home_directory.png)
<br/>
<br/>
* Select Java SDK from first step as the default Java SDK.
* Select Java SDK from the first step as the default Java SDK.
![Set IDEA JDK](set_java_sdk.png)
<br/>
<br/>
* In the Sourcepath tab of the SDK settings, click the *Add* button:
* In the Sourcepath tab of the SDK settings, click the *Add* button (_this step can be skipped if your plugin doesn't require debugging_):
![Add Sourcepath](add_sourcepath.png)
<br/>
<br/>
@ -55,6 +55,6 @@ To set up your plugin development environment:
Any directory can be chosen as the *Sandbox Home* location.
Use the ellipsis button (shown below) to define a custom location.
See the [IDE Development Instances](ide_development_instance.md) page for more information about default *Sandbox Home* directory locations and contents.
See the [IDE Development Instances](ide_development_instance.md) page for more information about the default *Sandbox Home* directory locations and contents.
![Specify Sandbox Path](plugins-sandbox.png)