Skip to content

Commit 56a8190

Browse files
authored
Revise IntelliJ setup instructions for clarity (#1519)
Updated instructions for setting up IntelliJ IDEA with JDK 17 and Gradle. Removed redundant steps and clarified JDK selection process.
1 parent 174753c commit 56a8190

1 file changed

Lines changed: 33 additions & 20 deletions

File tree

BUILD.md

Lines changed: 33 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,25 @@ Great to see you are interested in contributing to Processing. To get started yo
44

55
## IntelliJ IDEA (recommended)
66

7-
First, [download the IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/). Make sure to select the "Community Edition", not "Ultimate". The Community Edition is free and built on open-source software. You may need to scroll down to find the download link.
7+
_**Note:** A paid subscription is **not** required. Everything needed to build and work on Processing is available for free in IntelliJ IDEA._
8+
9+
1. [Download IntelliJ IDEA](https://www.jetbrains.com/idea/download/) and install it.
10+
1. Clone the `Processing4` repository locally.
11+
1. Open the cloned repository in **IntelliJ IDEA**.
12+
1. When prompted, select **Trust Project**. (You can preview the project in Safe Mode, but you will not be able to build Processing.)
13+
1. If IntelliJ asks whether to import the Gradle project, select **Load Gradle Project**.
14+
1. Make sure IntelliJ and Gradle are both using **JDK 17**:
15+
* Go to **`File > Project Structure > Project`**
16+
* Set **Project SDK** to **JDK 17** (we recommend **Eclipse Temurin**)
17+
* If needed, choose **Download JDK…** and install **Version 17**
18+
* Then go to **`Settings > Build, Execution, Deployment > Build Tools > Gradle`**
19+
* Set **Gradle JVM** to the same **JDK 17**
20+
1. Wait for Gradle sync to finish.
21+
1. Click the green **Run** button in the top right to build and launch Processing. You can also use this menu to start a debug session.
822

923
> [!TIP]
1024
> If you encounter any issues with this process, Read the [Troubleshooting and Setup Tips for IntelliJ IDEA](#troubleshooting-and-setup-tips-intellij-idea)
1125
12-
1. Clone the Processing4 repository to your machine locally
13-
1. Open the cloned repository in IntelliJ IDEA CE
14-
1. When prompted, select **Trust Project**. You can preview the project in Safe Mode but you won't be able to build Processing.
15-
1. IntelliJ may ask if you want to load Gradle project. If you allow this, make sure you are using JDK version 17.
16-
1. In the main menu, go to File > Project Structure > Project Settings > Project.
17-
1. In the SDK Dropdown option, select a JDK version 17 or Download the jdk
18-
1. Click the green Run Icon in the top right of the window. This is also where you can find the option to debug Processing.
19-
1. Logs can be found in the `Build` or `Debug` pane on the bottom left of the window
20-
21-
2226
## VSCode
2327
1. Clone the Processing4 repository to your machine locally
2428
1. Open the cloned repository in VScode
@@ -138,23 +142,32 @@ If you’re building Processing using IntelliJ IDEA and something’s not workin
138142
139143
### Use the Correct JDK (temurin-17)
140144
141-
Make sure IntelliJ is using **temurin-17**, not another version. Some users have reported issues with ms-17.
145+
Make sure IntelliJ is using **temurin-17**. Some users have reported issues with other distributions.
146+
147+
#### 1. Set the Project SDK
142148
143-
1. Go to **File > Project Structure > Project**
144-
2. Set the **Project SDK** to: `temurin-17 java version "17.0.15"`
149+
1. Go to **`File > Project Structure > Project`**
150+
1. Set the **`Project SDK`** to **`temurin-17`**
145151
146152
![JDK Selection](.github/media/troubleshooting-Intellij-setting-djk-version-manually.png)
147153
148-
If it is not already installed, you can download it by:
149-
1. Clicking the SDK input field and then selecting the `Download JDK...` option from the menu
150-
2. Select Version: `17`, Vendor: `Eclipse Temurin (AdoptOpenJDK HotSpot)`
154+
If Temurin 17 is not on the list, you should install it first:
155+
156+
1. Select the **`Download JDK...`** option from the menu
157+
1. Pick **Version**: **`17`**, **Vendor**: **`Eclipse Temurin (AdoptOpenJDK HotSpot)`**
158+
159+
<img width="400" alt="JDK Download" src="https://github.com/user-attachments/assets/503a03a4-3e53-4406-9641-2c93e4b45d51" />
160+
161+
#### 2. Set the Gradle JVM
151162
163+
Make sure Gradle also uses Temurin 17:
152164
153-
![JDK Download](.github/media/troubleshooting-Intellij-download-jdk.png)
165+
1. Go to **`Settings > Build, Execution, Deployment > Build Tools > Gradle`**
166+
1. Set **`Gradle JVM`** to **`temurin-17`**
154167
155-
Now go back to your main window and
156-
1. Click the green Run Icon in the top right of the window.
168+
_Note: the exact path in settings may vary depending on your version of IntelliJ._
157169
170+
<img width="800" alt="Gradle JVM" src="https://github.com/user-attachments/assets/ba620114-e663-4887-89e9-8f26fbfefbb2" />
158171
159172
### “Duplicate content roots detected”
160173

0 commit comments

Comments
 (0)