diff options
| author | Edwin Jakobs <edwin@rndr.studio> | 2019-08-01 18:03:09 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-08-01 18:03:09 +0200 |
| commit | 89e455d5f0cd50e43c511424bba80e3cafe268db (patch) | |
| tree | 76605838437cdf56d74a091a84f3eace479ce856 | |
| parent | a41b530d32c579c27d59857fee900bf9dd8bff9b (diff) | |
| download | art-playground-openrndr-89e455d5f0cd50e43c511424bba80e3cafe268db.tar.gz art-playground-openrndr-89e455d5f0cd50e43c511424bba80e3cafe268db.zip | |
Add README.md
Diffstat (limited to '')
| -rw-r--r-- | README.md | 12 |
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 |