From 89e455d5f0cd50e43c511424bba80e3cafe268db Mon Sep 17 00:00:00 2001 From: Edwin Jakobs Date: Thu, 1 Aug 2019 18:03:09 +0200 Subject: [PATCH] Add README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d96860d --- /dev/null +++ b/README.md @@ -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