From 97e24475b87d269631accf370071024ea1e228b0 Mon Sep 17 00:00:00 2001 From: Edwin Jakobs Date: Tue, 20 Nov 2018 15:36:02 +0100 Subject: [PATCH] Updated readme --- README.md | 78 +++++++++++++++++++++++++++---------------------------- 1 file changed, 39 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index b4c755f88..237fe6088 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,39 @@ -# ORX (OPENRNDR EXTRA) - -[![](https://jitpack.io/v/openrndr/orx.svg)](https://jitpack.io/#openrndr/orx) - -A growing library of assorted data structures, algorithms and utilities. - -- [`orx-compositor`](orx-compositor/README.md), a simple toolkit to make composite (layered) images -- [`orx-filter-extension`](orx-filter-extension/README.md), Program extension method that provides Filter based `extend()` -- [`orx-integral-image`](orx-integral-image/README.md), a CPU-based implementation for integral images (summed area tables) -- `orx-jumpflood`, a filter/shader based implementation of the jump flood algorithm for finding fast approximate (directional) distance fields -- `orx-kdtree`, a kd-tree implementation for fast nearest point searches -- [`orx-mesh-generators`](orx-mesh-generators/README.md), triangular mesh generators -- [`orx-no-clear`](orx-no-clear/README.md), a simple extension that provides drawing without clearing the background - -## Usage -ORX 0.0.12 is built against OPENRNDR 0.3.29, make sure you use this version in your project. Because OPENRNDR's API is pre 1.0 it tends to change from time to time. - -The easiest way to add ORX to your project is through the use of Jitpack. [Jitpack](http://jitpack.io) is a service that pulls Gradle based libraries from Github, builds them and serves the jar files. - -To setup Jitpack support in your project all you have to do is add the Jitpack repository to your `repositories {}`. It is advised to have the jitpack repository as the last entry. -``` -repositories { - maven { url 'https://jitpack.io' } -} -``` - -You can then add any of the ORX artefacts to your `dependencies {}`: -``` -dependencies { - compile 'com.github.openrndr.orx::v0.0.12' -} -``` - -For example if you want to use the `orx-no-clear` artifact one would use: -``` -dependencies { - compile 'com.github.openrndr.orx:orx-no-clear:v0.0.12' -} -``` +# ORX (OPENRNDR EXTRA) + +[![](https://jitpack.io/v/openrndr/orx.svg)](https://jitpack.io/#openrndr/orx) + +A growing library of assorted data structures, algorithms and utilities. + +- [`orx-compositor`](orx-compositor/README.md), a simple toolkit to make composite (layered) images +- [`orx-filter-extension`](orx-filter-extension/README.md), Program extension method that provides Filter based `extend()` +- [`orx-integral-image`](orx-integral-image/README.md), a CPU-based implementation for integral images (summed area tables) +- `orx-jumpflood`, a filter/shader based implementation of the jump flood algorithm for finding fast approximate (directional) distance fields +- `orx-kdtree`, a kd-tree implementation for fast nearest point searches +- [`orx-mesh-generators`](orx-mesh-generators/README.md), triangular mesh generators +- [`orx-no-clear`](orx-no-clear/README.md), a simple extension that provides drawing without clearing the background + +## Usage +ORX 0.0.13 is built against OPENRNDR 0.3.29, make sure you use this version in your project. Because OPENRNDR's API is pre 1.0 it tends to change from time to time. + +The easiest way to add ORX to your project is through the use of Jitpack. [Jitpack](http://jitpack.io) is a service that pulls Gradle based libraries from Github, builds them and serves the jar files. + +To setup Jitpack support in your project all you have to do is add the Jitpack repository to your `repositories {}`. It is advised to have the jitpack repository as the last entry. +``` +repositories { + maven { url 'https://jitpack.io' } +} +``` + +You can then add any of the ORX artefacts to your `dependencies {}`: +``` +dependencies { + compile 'com.github.openrndr.orx::v0.0.13' +} +``` + +For example if you want to use the `orx-no-clear` artifact one would use: +``` +dependencies { + compile 'com.github.openrndr.orx:orx-no-clear:v0.0.13' +} +```