cailean/openrndr-template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Add version badges, fix typo
This commit is contained in:
Abe Pazos
2023-03-15 19:28:10 +01:00
committed by Edwin Jakobs
parent 2113b159fe
commit d72cee08a9
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -23,14 +23,16 @@ To create runnable jars for a platform different from the platform you use to bu
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 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 the [libs.versions.toml](https://github.com/openrndr/openrndr-template/blob/master/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 version numbers of these dependencies are specified in the [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. In the Maven repository you can find a list with [openrndr versions](https://mvnrepository.com/artifact/org.openrndr/openrndr-application) and [orx versions](https://mvnrepository.com/artifact/org.openrndr.extra/orx-noise). To use the most recent versions copy the version numbers at the top of those lists into the toml file, for example: Newer versions of OPENRNDR and ORX bring useful features and bug fixes. The most recent versions are
![openrndr version](https://maven-badges.herokuapp.com/maven-central/org.openrndr/openrndr/badge.svg) (openrndr) and
![orx version](https://maven-badges.herokuapp.com/maven-central/org.openrndr/openrndr/badge.svg) (orx). To use these versions update the toml file. For example:
openrndr = "0.4.3-alpha3" openrndr = "0.4.3-alpha3"
orx = "0.4.3-alpha3" orx = "0.4.3-alpha3"
You can add other dependencies you project may need to the [build.gradle.kts](https://github.com/openrndr/openrndr-template/blob/16eb227741de1a4062a6e19c7c2b3761a62d4602/build.gradle.kts#L102) file. You can add other dependencies your project may need to the [build.gradle.kts](https://github.com/openrndr/openrndr-template/blob/16eb227741de1a4062a6e19c7c2b3761a62d4602/build.gradle.kts#L102) file.
Remember to reload the Gradle configuration after changing any dependencies. Remember to reload the Gradle configuration after changing any dependencies.