Add README.md
This commit is contained in:
12
README.md
Normal file
12
README.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# openrndr-template
|
||||||
|
A feature rich template for creating OPENRNDR programs based on Gradle/Kts
|
||||||
|
|
||||||
|
You will find some [basic instructions](https://guide.openrndr.org/#/02_Getting_Started_with_OPENRNDR/C00_SetupYourFirstProgram) in the [OPENRNDR guide](https://guide.openrndr.org)
|
||||||
|
|
||||||
|
The template consists of a configuration for Gradle and an example OPENRNDR program. The Gradle configuration should serve as the
|
||||||
|
go-to starting point for writing OPENRNDR-based software.
|
||||||
|
|
||||||
|
## Gradle tasks
|
||||||
|
- `run` runs the TemplateProgram
|
||||||
|
- `jar` creates an executable platform specific jar file with all dependencies
|
||||||
|
- `zipDistribution` creates a zip file containing the application jar and the data folder
|
||||||
Reference in New Issue
Block a user