aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEdwin Jakobs <edwin@rndr.studio>2019-08-07 10:21:39 +0200
committerEdwin Jakobs <edwin@rndr.studio>2019-08-07 10:21:39 +0200
commit545d9f2b5095530596a0c04b34d282508cfd79f1 (patch)
tree2771ce1fb75d52d9c2f8ac8ff5f51b434fa696d9 /README.md
parent0b4be71bba4f1858140ba974e0a8aa4b9d368e51 (diff)
parent89e455d5f0cd50e43c511424bba80e3cafe268db (diff)
downloadart-playground-openrndr-545d9f2b5095530596a0c04b34d282508cfd79f1.tar.gz
art-playground-openrndr-545d9f2b5095530596a0c04b34d282508cfd79f1.zip
Merge branch 'master' of github.com:openrndr/openrndr-template
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
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