You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: BUILD.md
+72-34Lines changed: 72 additions & 34 deletions
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,12 @@
2
2
3
3
Great to see you are interested in contributing to Processing. To get started you will need to have an IDE to build and develop Processing. Our recommendation and what we use ourselves is Intellij IDEA.
4
4
5
-
## IntelliJ IDEA
5
+
## IntelliJ IDEA (recommended)
6
6
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. Then:
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.
8
+
9
+
> [!TIP]
10
+
> If you encounter any issues with this process, Read the [Troubleshooting and Setup Tips for IntelliJ IDEA](#troubleshooting-and-setup-tips-intellij-idea)
8
11
9
12
1. Clone the Processing4 repository to your machine locally
10
13
1. Open the cloned repository in IntelliJ IDEA CE
@@ -25,6 +28,73 @@ First, [download the IntelliJ IDEA Community Edition](https://www.jetbrains.com/
25
28
26
29
Instructions for other editors are welcome and feel free to contribute the documentation for those [here](#other-editors)
27
30
31
+
## Other Editors
32
+
33
+
TBD
34
+
35
+
## Command Line
36
+
37
+
If you prefer not to use an IDE, you can also build Processing directly from the command line.
38
+
39
+
### Set Up the Environment
40
+
41
+
If you don't have them installed, you will need to install [Git](https://git-scm.com/downloads) and [Gradle](https://gradle.org/install/) first. Then follow these steps:
This compiles the source code and prepares everything needed to run or test Processing:
68
+
69
+
```bash
70
+
./gradlew build
71
+
```
72
+
73
+
#### Run Tests
74
+
75
+
Run unit tests and verify your build:
76
+
77
+
```bash
78
+
./gradlew test
79
+
```
80
+
81
+
#### Launch Processing
82
+
83
+
Start the Processing Development Environment (PDE):
84
+
85
+
```bash
86
+
./gradlew run
87
+
```
88
+
89
+
#### Create a Distributable Package (Optional)
90
+
91
+
Generate a packaged version of Processing, ready for distribution:
92
+
93
+
```bash
94
+
./gradlew package
95
+
```
96
+
97
+
The packaged files will be available in the `app/build/compose/binaries` directory.
28
98
29
99
## Architecture
30
100
Processing consists of three main components: `Core`, `Java`, and `App`. The `Core` is independent, while`Java` and `App` depend on it. Currently, `Java` and `App` are interdependent, but efforts are underway to decouple them.
@@ -60,36 +130,6 @@ The main task to run or debug the PDE is `run`. That means you just need to run
60
130
61
131
If your main concern is with the `Core` you don't need to build and start the whole PDE to test your changes. In IntelliJ IDEA you can selectany of the sketches in`core/examples/src/.../` to run by click on the green arrow next to their main functions. This will just compile core and the example sketch. Feel free to create additional examples for your new functionality.
62
132
63
-
## Other editors
64
-
65
-
### No editor, Linux or macOS
66
-
67
-
The first step is to install Temurin JDB 17 - LTS.
0 commit comments