From c6f608f880dc54acf4b14002d6fac86860d95640 Mon Sep 17 00:00:00 2001 From: Abe Pazos Date: Thu, 15 Aug 2024 16:24:44 +0200 Subject: Mention ORSL in the README --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ef09906..41d0c45 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,22 @@ To create a runnable jar for a platform different from your current platform, us ## Updating OPENRNDR, ORX and other dependencies -The openrndr-template depends on various packages including the core [openrndr](https://github.com/openrndr/openrndr/) and the [orx](https://github.com/openrndr/orx/) extensions. The version numbers of these dependencies are specified in your [libs.versions.toml](gradle/libs.versions.toml) file. If you want to learn about file format visit the [Gradle documentation](https://docs.gradle.org/current/userguide/platforms.html#sub:conventional-dependencies-toml) website. +The openrndr-template depends on various packages including the core [openrndr](https://github.com/openrndr/openrndr/) and the [orx](https://github.com/openrndr/orx/) extensions and +provides the optional [orsl](https://github.com/openrndr/orsl/) shader helper modules. +The version numbers of these dependencies are specified in your [libs.versions.toml](gradle/libs.versions.toml) file. +If you want to learn about file format visit the [Gradle documentation](https://docs.gradle.org/current/userguide/platforms.html#sub:conventional-dependencies-toml) website. -Newer versions of OPENRNDR and ORX bring useful features and bug fixes. The most recent versions are +Newer versions bring useful features and bug fixes. The most recent versions are
![openrndr version](https://maven-badges.herokuapp.com/maven-central/org.openrndr/openrndr-application/badge.svg) for OPENRNDR.
![orx version](https://maven-badges.herokuapp.com/maven-central/org.openrndr.extra/orx-parameters-jvm/badge.svg) for ORX. +
![orsl version](https://maven-badges.herokuapp.com/maven-central/org.openrndr.orsl/orsl-shader-generator-jvm/badge.svg) for ORSL. -Switch to the [next-version branch](https://github.com/openrndr/openrndr-template/tree/next-version) or enter these version numbers in your toml file. They can look like "0.4.3" or "0.4.3-alpha4". Use the complete string, as in: +Switch to the [next-version branch](https://github.com/openrndr/openrndr-template/tree/next-version) or enter these version numbers in your toml file. +They can look like "0.4.3" or "0.4.3-alpha4". Use the complete string, as in: - openrndr = "0.4.3-alpha4" - orx = "0.4.3-alpha4" + openrndr = "0.4.5-alpha5" + orx = "0.4.5-alpha5" + orsl = "0.4.5-alpha5" You can add other dependencies needed by your project to your [build.gradle.kts](build.gradle.kts) file, inside the `dependencies { }` block. -- cgit v1.3.1 From 1565ef12bedda32133afd2ae2fd82cfb496730db Mon Sep 17 00:00:00 2001 From: Abe Pazos Date: Sat, 16 Nov 2024 18:37:32 +0100 Subject: Update README.md Mention how to specify a main method to run after using shadowJar Simplify the text. --- README.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 41d0c45..64ba437 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ You will find some [basic instructions](https://guide.openrndr.org/setUpYourFirs ## Gradle tasks - `./gradlew run` runs the TemplateProgram (Use `gradlew.bat run` under Windows) - - `./gradlew shadowJar` creates an executable platform specific jar file with all dependencies. Run the resulting program by typing `java -jar build/libs/openrndr-template-1.0.0-all.jar` in a terminal from the project root. + - `./gradlew shadowJar` creates an executable platform specific jar file with all dependencies. Run the resulting program by typing `java -jar build/libs/openrndr-template-1.0.0-all.jar` in a terminal from the project root. If your project contains multiple `main` methods, specify which one to run with `java -cp build/libs/openrndr-template-1.0.0-all.jar MyProgramKt`, where `MyProgramKt` can also be `foo.bar.MyProgramKt` if it's in the package `foo.bar`. - `./gradlew jpackageZip` creates a zip with a stand-alone executable for the current platform (works with Java 14 only) ## Cross builds @@ -24,14 +24,14 @@ To create a runnable jar for a platform different from your current platform, us The openrndr-template depends on various packages including the core [openrndr](https://github.com/openrndr/openrndr/) and the [orx](https://github.com/openrndr/orx/) extensions and provides the optional [orsl](https://github.com/openrndr/orsl/) shader helper modules. The version numbers of these dependencies are specified in your [libs.versions.toml](gradle/libs.versions.toml) file. -If you want to learn about file format visit the [Gradle documentation](https://docs.gradle.org/current/userguide/platforms.html#sub:conventional-dependencies-toml) website. +Learn more about this file in the [Gradle documentation](https://docs.gradle.org/current/userguide/platforms.html#sub:conventional-dependencies-toml) website. Newer versions bring useful features and bug fixes. The most recent versions are
![openrndr version](https://maven-badges.herokuapp.com/maven-central/org.openrndr/openrndr-application/badge.svg) for OPENRNDR.
![orx version](https://maven-badges.herokuapp.com/maven-central/org.openrndr.extra/orx-parameters-jvm/badge.svg) for ORX.
![orsl version](https://maven-badges.herokuapp.com/maven-central/org.openrndr.orsl/orsl-shader-generator-jvm/badge.svg) for ORSL. -Switch to the [next-version branch](https://github.com/openrndr/openrndr-template/tree/next-version) or enter these version numbers in your toml file. +Switch to the [next-version branch](https://github.com/openrndr/openrndr-template/tree/next-version) or enter these versions manually in your toml file. They can look like "0.4.3" or "0.4.3-alpha4". Use the complete string, as in: openrndr = "0.4.5-alpha5" @@ -40,7 +40,7 @@ They can look like "0.4.3" or "0.4.3-alpha4". Use the complete string, as in: You can add other dependencies needed by your project to your [build.gradle.kts](build.gradle.kts) file, inside the `dependencies { }` block. -Remember to reload the Gradle configuration after changing any dependencies. +⚠️ Remember to reload the Gradle configuration after changing any dependencies. ## Run other Kotlin programs from the command line @@ -56,19 +56,16 @@ To run `src/main/kotlin/foo/bar/myProgram.kt` (assuming `package foo.bar` in myP ## Github Actions -This repository contains a number of Github Actions under `./github/workflows`. +This repository contains various Github Actions under `./github/workflows`: -[build-on-commit.yaml](.github/workflows/build-on-commit.yaml) runs a basic build on every commit, +- [build-on-commit.yaml](.github/workflows/build-on-commit.yaml) runs a basic build on every commit, which can help detect issues in the source code. -[publish-binaries.yaml](.github/workflows/publish-binaries.yaml) publishes binaries for Linux, Mac and Windows -any time a commit is tagged with a version number like `v1.*`. - -For example, we can create and push a tag with these git commands: - +- [publish-binaries.yaml](.github/workflows/publish-binaries.yaml) publishes binaries for Linux, Mac and Windows +any time a commit is tagged with a version number like `v1.*`. For example, we can create and push a tag with these git commands: + ``` git tag -a v1.0.0 -m "v1.0.0" git push origin v1.0.0 + ``` -The progress of the running actions can be followed under the Actions tab in GitHub. -Once complete, the executables will be found under the Releases section. - + You can follow the progress of the action under the Actions tab in GitHub. Once complete, the executables will appear under the Releases section. -- cgit v1.3.1 From fef8e76e52d5059d64a497e671be17da04af2611 Mon Sep 17 00:00:00 2001 From: Abe Pazos Date: Fri, 2 May 2025 19:01:38 +0300 Subject: Describe how to run the executable created by jpackage --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 64ba437..9c323ea 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ You will find some [basic instructions](https://guide.openrndr.org/setUpYourFirs - `./gradlew run` runs the TemplateProgram (Use `gradlew.bat run` under Windows) - `./gradlew shadowJar` creates an executable platform specific jar file with all dependencies. Run the resulting program by typing `java -jar build/libs/openrndr-template-1.0.0-all.jar` in a terminal from the project root. If your project contains multiple `main` methods, specify which one to run with `java -cp build/libs/openrndr-template-1.0.0-all.jar MyProgramKt`, where `MyProgramKt` can also be `foo.bar.MyProgramKt` if it's in the package `foo.bar`. - - `./gradlew jpackageZip` creates a zip with a stand-alone executable for the current platform (works with Java 14 only) + - `./gradlew jpackageZip` creates a zip with a stand-alone executable for the current platform (works with Java 14 only). Run it like this: `cd build/jpackage/openrndr-application/ && bin/openrndr-application`. ## Cross builds -- cgit v1.3.1 From 7597ac35e269baf1823575a8fbf32a2123e9251f Mon Sep 17 00:00:00 2001 From: Abe Pazos Date: Fri, 22 Aug 2025 12:03:35 +0000 Subject: Update README.md Simplify README by merging two sections --- README.md | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9c323ea..0e29ba7 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,16 @@ go-to starting point for writing OPENRNDR-based software. If you are looking at this from IntelliJ IDEA you can start by expanding the _project_ tab on the left. You will find a template program in `src/main/kotlin/TemplateProgram.kt` and a live-coding example in `src/main/kotlin/TemplateLiveProgram.kt`. -You will find some [basic instructions](https://guide.openrndr.org/setUpYourFirstProgram.html) in the [OPENRNDR guide](https://guide.openrndr.org) +You will find some [basic instructions](https://guide.openrndr.org/setUpYourFirstProgram.html) in the [OPENRNDR guide](https://guide.openrndr.org). ## Gradle tasks - - `./gradlew run` runs the TemplateProgram (Use `gradlew.bat run` under Windows) + - `./gradlew run` runs `TemplateProgram.kt` (Use `gradlew.bat run` under Windows) + - `./gradlew run -Popenrndr.application=MyProgramKt` runs `src/main/kotlin/myProgram.kt` + - `./gradlew run -Popenrndr.application=foo.bar.MyProgramKt` runs `src/main/kotlin/foo/bar/myProgram.kt` (assuming `package foo.bar` is used in myProgram.kt) - `./gradlew shadowJar` creates an executable platform specific jar file with all dependencies. Run the resulting program by typing `java -jar build/libs/openrndr-template-1.0.0-all.jar` in a terminal from the project root. If your project contains multiple `main` methods, specify which one to run with `java -cp build/libs/openrndr-template-1.0.0-all.jar MyProgramKt`, where `MyProgramKt` can also be `foo.bar.MyProgramKt` if it's in the package `foo.bar`. - `./gradlew jpackageZip` creates a zip with a stand-alone executable for the current platform (works with Java 14 only). Run it like this: `cd build/jpackage/openrndr-application/ && bin/openrndr-application`. + - `./gradlew dependencyUpydates` checks whether any dependencies have newer versions. ## Cross builds @@ -42,18 +45,6 @@ You can add other dependencies needed by your project to your [build.gradle.kts] ⚠️ Remember to reload the Gradle configuration after changing any dependencies. -## Run other Kotlin programs from the command line - -By default `./gradlew run` runs a program called `TemplateProgram.kt` but a different one can be provided as an argument: - -To run `src/main/kotlin/myProgram.kt` - - ./gradlew run -Popenrndr.application=MyProgramKt - -To run `src/main/kotlin/foo/bar/myProgram.kt` (assuming `package foo.bar` in myProgram.kt) - - ./gradlew run -Popenrndr.application=foo.bar.MyProgramKt - ## Github Actions This repository contains various Github Actions under `./github/workflows`: -- cgit v1.3.1 From a385ebb21664155b885e5455d5355aa47bd22bd0 Mon Sep 17 00:00:00 2001 From: Abe Pazos Date: Tue, 26 Aug 2025 15:11:52 +0200 Subject: Update badges in README.md Previous ones stopped working --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0e29ba7..6eb172b 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,10 @@ provides the optional [orsl](https://github.com/openrndr/orsl/) shader helper mo The version numbers of these dependencies are specified in your [libs.versions.toml](gradle/libs.versions.toml) file. Learn more about this file in the [Gradle documentation](https://docs.gradle.org/current/userguide/platforms.html#sub:conventional-dependencies-toml) website. -Newer versions bring useful features and bug fixes. The most recent versions are -
![openrndr version](https://maven-badges.herokuapp.com/maven-central/org.openrndr/openrndr-application/badge.svg) for OPENRNDR. -
![orx version](https://maven-badges.herokuapp.com/maven-central/org.openrndr.extra/orx-parameters-jvm/badge.svg) for ORX. -
![orsl version](https://maven-badges.herokuapp.com/maven-central/org.openrndr.orsl/orsl-shader-generator-jvm/badge.svg) for ORSL. +Newer versions bring useful features and bug fixes. The most recent versions are
+![Maven Central Version](https://img.shields.io/maven-central/v/org.openrndr/openrndr-math-jvm?label=OPENRNDR&color=%23FFC0CB) +![Maven Central Version](https://img.shields.io/maven-central/v/org.openrndr.extra/orx-noise-jvm?label=ORX&color=%23FFC0CB) +![Maven Central Version](https://img.shields.io/maven-central/v/org.openrndr.orsl/orsl-shader-generator-jvm?label=ORSL&color=%23FFC0CB). Switch to the [next-version branch](https://github.com/openrndr/openrndr-template/tree/next-version) or enter these versions manually in your toml file. They can look like "0.4.3" or "0.4.3-alpha4". Use the complete string, as in: -- cgit v1.3.1