Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update core/README.md on how to use the core library from Maven Central. #859

Merged
merged 1 commit into from
Nov 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions core/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,65 @@
# Including the Processing Core library on your project
Processing’s core libraries are available through [Maven Central](https://central.sonatype.com/artifact/org.processing/core).
This allows integration of Processing into Java-based projects using build tools like Maven or Gradle.

> [!IMPORTANT]
> Repository https://jogamp.org/deployment/maven must be added to the repository list.
>
> This is because the core library depends on some external libraries that are hosted on the aftermentioned repository.
> See the [Examples](#Examples) section on how to do this.

## Examples
Here are some examples on how to add the Processing core library to the Maven and Gradle build systems.
All examples consist on two parts:
1. Adds the https://jogamp.org/deployment/maven repository to the build system to satisfy dependencies needed by the Processing core library.
2. Adds the Processing core library as a dependency to your project.
### Maven
```xml
<repositories>
<repository>
<id>jogamp</id>
<url>https://jogamp.org/deployment/maven</url>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>org.processing</groupId>
<artifactId>core</artifactId>
<version>4.3.1</version>
</dependency>
</dependencies>
```
### Gradle (kotlin)
```gradle
repositories {
mavenCentral()
maven {
url = uri("https://jogamp.org/deployment/maven")
}
}

dependencies {
implementation("org.processing:core:4.3.1")
}
```
### Gradle (groovy)
```gradle
repositories {
mavenCentral()
maven {
url = uri("https://jogamp.org/deployment/maven")
}
}

dependencies {
implementation group: 'org.processing', name: 'core', version: '4.3.1'
}
```
### Other
Other example snippets on including the library are included in the [Maven Central repo](https://central.sonatype.com/artifact/org.processing/core).
Please look up on how to add the custom https://jogamp.org/deployment/maven repository to your build system.

## There are significant changes to `core` in Processing 3.


Expand Down