Skip to content

Commit

Permalink
Improve descriptions in README files, displayed in the main README.md. (
Browse files Browse the repository at this point in the history
  • Loading branch information
hamoid authored Apr 27, 2023
1 parent 8cf89d4 commit f7fda5f
Show file tree
Hide file tree
Showing 25 changed files with 52 additions and 50 deletions.
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,41 +9,41 @@ complement [OPENRNDR](https://github.com/openrndr/openrndr).

| name                                     | description |
| --- | --- |
| [`orx-camera`](orx-camera/) | 3D camera controllable via mouse and keyboard. |
| [`orx-color`](orx-color/) | Tools to work with color |
| [`orx-camera`](orx-camera/) | 2D and 3D cameras controllable via mouse and keyboard. |
| [`orx-color`](orx-color/) | Color spaces, palettes, histograms, named colors. |
| [`orx-compositor`](orx-compositor/) | Toolkit to make composite (layered) images using blend modes and filters. |
| [`orx-compute-graph`](orx-compute-graph/) | A graph for computation. |
| [`orx-compute-graph-nodes`](orx-compute-graph-nodes/) | A collection of nodes that can be used with orx-computer-graph. |
| [`orx-delegate-magic`](orx-delegate-magic/) | Collection of magical property delegators |
| [`orx-easing`](orx-easing/) | Provides easing functions for smooth animation or non-linear interpolation. |
| [`orx-envelopes`](orx-envelopes/) | ADSR envelopes and tools |
| [`orx-fx`](orx-fx/) | Ready-to-use visual effects or filters. Most include [orx-parameters](https://github.com/openrndr/orx/tree/master/orx-parameters) annotations so they can be easily controlled via orx-gui. |
| [`orx-compute-graph-nodes`](orx-compute-graph-nodes/) | A collection of nodes that can be used with `orx-computer-graph`. |
| [`orx-delegate-magic`](orx-delegate-magic/) | Collection of magical property delegators. For tracking variable change or interpolate towards the value of a variable. |
| [`orx-easing`](orx-easing/) | Easing functions for smooth animation or non-linear interpolation. |
| [`orx-envelopes`](orx-envelopes/) | ADSR (Attack, Decay, Sustain, Release) envelopes and tools. |
| [`orx-fx`](orx-fx/) | Ready-to-use GPU-based visual effects or filters. Most include [orx-parameters](https://github.com/openrndr/orx/tree/master/orx-parameters) annotations so they can be easily controlled via orx-gui. |
| [`orx-glslify`](orx-glslify/) | Load glslify compatible shaders from [npm](https://www.npmjs.com/search?q=glslify). |
| [`orx-gradient-descent`](orx-gradient-descent/) | Finds equation inputs that output a minimum value: easy to use gradient descent based minimizer. |
| [`orx-hash-grid`](orx-hash-grid/) | A 2D space partitioning for points. |
| [`orx-image-fit`](orx-image-fit/) | Draws the given image making sure it fits (`contain`) or it covers (`cover`) the specified area. |
| [`orx-hash-grid`](orx-hash-grid/) | 2D space partitioning for fast point queries. |
| [`orx-image-fit`](orx-image-fit/) | Draws an image ensuring it fits or covers the specified `Rectangle`. |
| [`orx-integral-image`](orx-integral-image/) | CPU and GPU-based implementation for integral images (summed area tables) |
| [`orx-interval-tree`](orx-interval-tree/) | For querying a data set containing time segments (start time and end time) when we need all entries containing a specific time value. Useful when creating a timeline. |
| [`orx-jumpflood`](orx-jumpflood/) | Takes an image and calculates either a distance field or a direction field. GPU accelerated, 2D. Results are provided as an image. |
| [`orx-kdtree`](orx-kdtree/) | Fast search of the point closest to the queried point in a data set. 2D, 3D and 4D. |
| [`orx-jumpflood`](orx-jumpflood/) | Calculates distance or direction fields from an image. GPU accelerated, 2D. Results are provided as an image. |
| [`orx-kdtree`](orx-kdtree/) | Fast search of points closest to the queried point in a data set. 2D, 3D and 4D. |
| [`orx-marching-squares`](orx-marching-squares/) | Tools for extracting contours from functions |
| [`orx-mesh-generators`](orx-mesh-generators/) | Generates various types of 3D meshes. |
| [`orx-no-clear`](orx-no-clear/) | Provides the classical draw-without-clearing-the-screen functionality that OPENRNDR does not provide by default. |
| [`orx-mesh-generators`](orx-mesh-generators/) | 3D-mesh generating functions and DSL. |
| [`orx-no-clear`](orx-no-clear/) | Provides the classical "draw-without-clearing-the-screen" functionality. |
| [`orx-noise`](orx-noise/) | Randomness for every type of person: Perlin, uniform, value, simplex, fractal and many other types of noise. |
| [`orx-obj-loader`](orx-obj-loader/) | Simple loader for Wavefront .obj 3D mesh files. |
| [`orx-palette`](orx-palette/) | Provides 300 color palettes gathered from different sources, organized in 3 collections. |
| [`orx-palette`](orx-palette/) | Provides hundreds of color palettes. |
| [`orx-parameters`](orx-parameters/) | Provides annotations and tools for turning Kotlin properties into introspectable parameters. Used by [`orx-gui`](../orx-gui/README.md) to automatically generate user interfaces. |
| [`orx-property-watchers`](orx-property-watchers/) | Tools for setting up property watcher based pipelines |
| [`orx-quadtree`](orx-quadtree/) | An extension for creating a [Quadtree](https://en.wikipedia.org/wiki/Quadtree) for points. A quadtree is a spatial partioning tree structure meant to provide fast spatial queries such as nearest points within a range. |
| [`orx-shade-styles`](orx-shade-styles/) | Collection of shader based fills and strokes. Currently includes 4 types of gradient fills. |
| [`orx-quadtree`](orx-quadtree/) | A [Quadtree](https://en.wikipedia.org/wiki/Quadtree) is a spatial partioning tree structure meant to provide fast spatial queries such as nearest points within a range. |
| [`orx-shade-styles`](orx-shade-styles/) | Shader based fills and strokes, including various types of gradient fills. |
| [`orx-shader-phrases`](orx-shader-phrases/) | A library that provides a `#pragma import` statement for shaders. |
| [`orx-shapes`](orx-shapes/) | Collection of 2D shape generators (polygon, star, rounded rectangle) and shape modifiers. |
| [`orx-shapes`](orx-shapes/) | Collection of 2D shape generators and modifiers. |
| [`orx-temporal-blur`](orx-temporal-blur/) | Post-processing temporal-blur video effect. CPU intense, therefore not intended for use with the `ScreenRecorder` extension or other real-time uses. |
| [`orx-time-operators`](orx-time-operators/) | A collection of time-sensitive functions aimed at controlling raw data over-time, such as Envelope and LFO. |
| [`orx-timer`](orx-timer/) | Simple timer functionality providing `repeat`, to run code with a given interval and `timeOut`, to run code once after a given delay. |
| [`orx-triangulation`](orx-triangulation/) | An extension for triangulating a set of points using the **Delaunay** triangulation method. From that triangulation we can also derive a **Voronoi** diagram. |
| [`orx-turtle`](orx-turtle/) | Bezier (`ShapeContour`) backed turtle graphics. |
| [`orx-view-box`](orx-view-box/) | Tools to provide view box support |
| [`orx-triangulation`](orx-triangulation/) | **Delaunay** triangulation and **Voronoi** diagrams. |
| [`orx-turtle`](orx-turtle/) | Bezier (`ShapeContour`) backed [turtle graphics](https://en.wikipedia.org/wiki/Turtle_graphics). |
| [`orx-view-box`](orx-view-box/) | To create independent views inside one program window. |

## JVM only

Expand All @@ -52,23 +52,23 @@ complement [OPENRNDR](https://github.com/openrndr/openrndr).
| [`orx-boofcv`](orx-jvm/orx-boofcv/) | Helper functions to ease working with the BoofCV computer vision library and its data types. |
| [`orx-chataigne`](orx-jvm/orx-chataigne/) | Expose variables to [Chataigne](http://benjamin.kuperberg.fr/chataigne/en) and any other applications that can interface with it. The current implementation makes use of the OSC protocol and supports `Double` and `ColorRGBa`. |
| [`orx-dnk3`](orx-jvm/orx-dnk3/) | A scene graph based 3d renderer with support for Gltf based assets |
| [`orx-expression-evaluator`](orx-jvm/orx-expression-evaluator/) | Tools to evaluate expression strings |
| [`orx-expression-evaluator`](orx-jvm/orx-expression-evaluator/) | Tools to evaluate strings containing mathematical expressions. |
| [`orx-file-watcher`](orx-jvm/orx-file-watcher/) | Monitor files on disk and auto-reload them if they change. |
| [`orx-git-archiver`](orx-jvm/orx-git-archiver/) | An extension that hooks into `Program.requestAssets` to commit changed code to Git and provide filenames based on the commit hash. |
| [`orx-git-archiver-gradle`](orx-jvm/orx-git-archiver-gradle/) | A Gradle plugin that turns a git history and `screenshots` directory into a markdown file. |
| [`orx-gui`](orx-jvm/orx-gui/) | Automatic UI (sliders, buttons, etc.) generated from annotated classes and properties. Uses `orx-panel` and `orx-parameters`. |
| [`orx-keyframer`](orx-jvm/orx-keyframer/) | Create animated timelines by specifying properties and times in keyframes, then play it back at any speed (even backwards) automatically interpolating properties. Save, load, use mathematical expressions and callbacks. Powerful and highly reusable. |
| [`orx-kinect-v1`](orx-jvm/orx-kinect-v1/) | Support for the Kinect V1 RGB+Depth camera. |
| [`orx-midi`](orx-jvm/orx-midi/) | Basic MIDI support for keyboards and controllers. Send and receive note and control change events. |
| [`orx-minim`](orx-jvm/orx-minim/) | A minimal Minim support library |
| [`orx-midi`](orx-jvm/orx-midi/) | MIDI support for keyboards and controllers. Send and receive note and control change events. Bind inputs to variables. |
| [`orx-minim`](orx-jvm/orx-minim/) | Simplifies working with the Minim sound library. Provides sound synthesis and analysis. |
| [`orx-olive`](orx-jvm/orx-olive/) | Provides live coding functionality: updates a running OPENRNDR program when you save your changes. |
| [`orx-osc`](orx-jvm/orx-osc/) | Open Sound Control makes it possible to send and receive messages from other OSC enabled programs in the same or a different computer. Used to create multi-application or multi-device software. |
| [`orx-panel`](orx-jvm/orx-panel/) | The OPENRNDR UI toolkit. Provides buttons, sliders, text, a color picker and much more. HTML/CSS-like. |
| [`orx-poisson-fill`](orx-jvm/orx-poisson-fill/) | Post processing effect that fills transparent parts of the image interpolating the edge pixel colors. GPU-based. |
| [`orx-rabbit-control`](orx-jvm/orx-rabbit-control/) | Creates a web-based remote UI to control your OPENRNDR program from a mobile device or a different computer. Alternative to `orx-gui`. |
| [`orx-runway`](orx-jvm/orx-runway/) | Interfaces with the RunwayML machine learning library that provides features like motion capture, image synthesis, object recognition, style transfer and more. More info at [runwayml.com](https://runwayml.com/). |
| [`orx-syphon`](orx-jvm/orx-syphon/) | Send frames to- and from OPENRNDR to other applications in real time using _Syphon_ for Mac. |
| [`orx-video-profiles`](orx-jvm/orx-video-profiles/) | A collection of `VideoWriterProfile` implementations that can be used with `ScreenRecorder` and `VideoWriter` |
| [`orx-video-profiles`](orx-jvm/orx-video-profiles/) | GIF, H265, PNG, Prores, TIFF and Webp `VideoWriterProfile`s for `ScreenRecorder` and `VideoWriter`. |
<!-- __orxListEnd__ -->

# Developer notes
Expand Down
2 changes: 1 addition & 1 deletion orx-camera/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-camera

3D camera controllable via mouse and keyboard.
2D and 3D cameras controllable via mouse and keyboard.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion orx-color/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-color

Tools to work with color
Color spaces, palettes, histograms, named colors.

## Color presets

Expand Down
2 changes: 1 addition & 1 deletion orx-compute-graph-nodes/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-compute-graph-nodes

A collection of nodes that can be used with orx-computer-graph.
A collection of nodes that can be used with `orx-computer-graph`.

## List of nodes

Expand Down
3 changes: 2 additions & 1 deletion orx-delegate-magic/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# orx-delegate magic

Collection of magical property delegators
Collection of magical property delegators. For tracking variable change or
interpolate towards the value of a variable.

## Delegated properties

Expand Down
2 changes: 1 addition & 1 deletion orx-easing/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-easing

Provides easing functions for smooth animation or non-linear interpolation.
Easing functions for smooth animation or non-linear interpolation.

Similar to those on https://easings.net

Expand Down
2 changes: 1 addition & 1 deletion orx-envelopes/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-envelopes

ADSR envelopes and tools
ADSR (Attack, Decay, Sustain, Release) envelopes and tools.

## ADSR

Expand Down
2 changes: 1 addition & 1 deletion orx-fx/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-fx

Ready-to-use visual effects or filters. Most include
Ready-to-use GPU-based visual effects or filters. Most include
[orx-parameters](https://github.com/openrndr/orx/tree/master/orx-parameters) annotations
so they can be easily controlled via orx-gui.

Expand Down
2 changes: 1 addition & 1 deletion orx-hash-grid/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-hash-grid

A 2D space partitioning for points.
2D space partitioning for fast point queries.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion orx-image-fit/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-image-fit

Draws the given image making sure it fits (`contain`) or it covers (`cover`) the specified area.
Draws an image ensuring it fits or covers the specified `Rectangle`.

Similar to CSS object-fit (https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit)

Expand Down
2 changes: 1 addition & 1 deletion orx-jumpflood/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-jumpflood

Takes an image and calculates either a distance field or a direction field.
Calculates distance or direction fields from an image.
GPU accelerated, 2D. Results are provided as an image.

[Original jump flooding algorithm](https://www.comp.nus.edu.sg/~tants/jfa.html)
Expand Down
2 changes: 1 addition & 1 deletion orx-jvm/orx-expression-evaluator/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-expression-evaluator

Tools to evaluate expression strings
Tools to evaluate strings containing mathematical expressions.

# Expression evaluator

Expand Down
3 changes: 2 additions & 1 deletion orx-jvm/orx-midi/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# orx-midi

Basic MIDI support for keyboards and controllers. Send and receive note and control change events.
MIDI support for keyboards and controllers. Send and receive note and control change events.
Bind inputs to variables.

Orx-midi is a wrapper around javax.midi.

Expand Down
3 changes: 2 additions & 1 deletion orx-jvm/orx-minim/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# orx-minim

A minimal Minim support library
Simplifies working with the Minim sound library.
Provides sound synthesis and analysis.

## Usage

Expand Down
4 changes: 2 additions & 2 deletions orx-jvm/orx-video-profiles/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-video-profiles

A collection of `VideoWriterProfile` implementations that can be used with `ScreenRecorder` and `VideoWriter`
GIF, H265, PNG, Prores, TIFF and Webp `VideoWriterProfile`s for `ScreenRecorder` and `VideoWriter`.

## Usage

Expand All @@ -24,7 +24,7 @@ fun main() = application {
}
```

Later use `gifsicle` or similar to further reduce file size. For example:
Then use `gifsicle` or a similar tool to reduce the gif file size. For example:

```
$ gifsicle --loop --delay=4 --colors 16 --optimize=2 heavy.gif >lessheavy.gif
Expand Down
2 changes: 1 addition & 1 deletion orx-kdtree/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-kdtree

Fast search of the point closest to the queried point in a data set. 2D, 3D and 4D.
Fast search of points closest to the queried point in a data set. 2D, 3D and 4D.

<!-- __demos__ -->
## Demos
Expand Down
2 changes: 1 addition & 1 deletion orx-mesh-generators/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-mesh-generators

Generates various types of 3D meshes.
3D-mesh generating functions and DSL.

## Simple meshes

Expand Down
3 changes: 1 addition & 2 deletions orx-no-clear/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# orx-no-clear

Provides the classical draw-without-clearing-the-screen functionality that
OPENRNDR does not provide by default.
Provides the classical "draw-without-clearing-the-screen" functionality.

#### Usage

Expand Down
2 changes: 1 addition & 1 deletion orx-palette/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-palette

Provides 300 color palettes gathered from different sources, organized in 3 collections.
Provides hundreds of color palettes.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion orx-quadtree/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-quadtree

An extension for creating a [Quadtree](https://en.wikipedia.org/wiki/Quadtree) for points. A quadtree is a spatial
A [Quadtree](https://en.wikipedia.org/wiki/Quadtree) is a spatial
partioning tree structure meant to provide fast spatial queries such as nearest points within a range.

## Example
Expand Down
2 changes: 1 addition & 1 deletion orx-shade-styles/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-shade-styles

Collection of shader based fills and strokes. Currently includes 4 types of gradient fills.
Shader based fills and strokes, including various types of gradient fills.

<!-- __demos__ >
# Demos
Expand Down
2 changes: 1 addition & 1 deletion orx-shapes/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-shapes

Collection of 2D shape generators (polygon, star, rounded rectangle) and shape modifiers.
Collection of 2D shape generators and modifiers.

<!-- __demos__ -->
## Demos
Expand Down
2 changes: 1 addition & 1 deletion orx-triangulation/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-triangulation

An extension for triangulating a set of points using the **Delaunay** triangulation method. From that triangulation we can also derive a **Voronoi** diagram.
**Delaunay** triangulation and **Voronoi** diagrams.

The functionality comes from a Javascript port of the following libraries:

Expand Down
2 changes: 1 addition & 1 deletion orx-turtle/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-turtle

Bezier (`ShapeContour`) backed turtle graphics.
Bezier (`ShapeContour`) backed [turtle graphics](https://en.wikipedia.org/wiki/Turtle_graphics).

## The turtle language

Expand Down
2 changes: 1 addition & 1 deletion orx-view-box/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orx-view-box

Tools to provide view box support
To create independent views inside one program window.

<!-- __demos__ -->
## Demos
Expand Down

0 comments on commit f7fda5f

Please sign in to comment.