Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tttapa committed Oct 3, 2021
1 parent 177150f commit e654266
Showing 1 changed file with 18 additions and 6 deletions.
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,18 @@

# Control Surface

An Arduino library for MIDI controllers and control surfaces.
It includes a general-purpose MIDI abstraction layer as well, which can be useful
for any MIDI-related project.
Control surfaces with both MIDI outputs (potentiometers, buttons, etc.) and
MIDI inputs (LEDs, displays, etc.) are supported.
Control Surface is an Arduino library for building MIDI controllers and control
surfaces.
At its core is a
[general-purpose MIDI abstraction layer](https://tttapa.github.io/Control-Surface-doc/Doxygen/d3/df7/midi-tutorial.html)
with support for serial MIDI, MIDI over USB, MIDI over BLE, etc., which can be
useful for any MIDI-related project.
Besides MIDI input/output, Control Surface also includes easy-to-use utilities
specifically for building MIDI controllers, supporting controls that send MIDI
─ like potentiometers, push buttons, rotary encoders, etc. ─
and controls that react to incoming MIDI ─ LEDs, displays, and so on.
They can also be combined into controls that use both MIDI input and output,
such as motorized faders.

> Table of contents
> <span class="mono">¶</span>&emsp;[Overview](#overview)
Expand Down Expand Up @@ -73,6 +80,12 @@ implemented.

<sub>→ [_MIDI Input Elements documentation_](https://tttapa.github.io/Control-Surface-doc/Doxygen/df/d8b/group__MIDIInputElements.html)</sub>

### Motorized faders

- **Motorized faders** are supported through the [tttapa/Control-Surface-Motor-Fader](https://github.com/tttapa/Control-Surface-Motor-Fader) repository.

<sub>→ [_Control Surface Motor Fader documentation_](https://tttapa.github.io/Pages/Arduino/Control-Theory/Motor-Fader/)</sub>

### Bank support

All controls can be arranged in **banks**: for example, if you have only 4
Expand Down Expand Up @@ -214,7 +227,6 @@ page.
## Work in progress
- Adding support for motorized faders
- Adding more tests (currently at over 560 unit tests)
- Adding more examples and adding comments to existing examples
- Finishing the documentation
Expand Down

0 comments on commit e654266

Please sign in to comment.