diff --git a/README.md b/README.md index e42d171..3b8608e 100644 --- a/README.md +++ b/README.md @@ -8,56 +8,58 @@ This library enables MIDI I/O communications on the Arduino serial ports. ### Features -* Compatible with all Arduino boards (and clones with an AVR processor). -* Simple and fast way to send and receive every kind of MIDI message (including all System messages, SysEx, Clock, etc..). -* OMNI input reading (read all channels). -* Software Thru, with message filtering. -* [Callbacks](http://playground.arduino.cc/Main/MIDILibraryCallbacks) to handle input messages more easily. -* Last received message is saved until a new one arrives. -* Configurable: [overridable template-based settings](https://github.com/FortySevenEffects/arduino_midi_library/wiki/Using-custom-Settings). -* Create more than one MIDI port for mergers/splitters applications. -* Use any serial port, hardware or software. + +- Compatible with all Arduino boards (and clones with an AVR processor). +- Simple and fast way to send and receive every kind of MIDI message (including all System messages, SysEx, Clock, etc..). +- OMNI input reading (read all channels). +- Software Thru, with message filtering. +- [Callbacks](https://github.com/FortySevenEffects/arduino_midi_library/wiki/Using-Callbacks) to handle input messages more easily. +- Last received message is saved until a new one arrives. +- Configurable: [overridable template-based settings](https://github.com/FortySevenEffects/arduino_midi_library/wiki/Using-custom-Settings). +- Create more than one MIDI port for mergers/splitters applications. +- Use any serial port, hardware or software. ### Getting Started 1. Use Arduino's Library Manager to install the library. -![Type "MIDI" in the Arduino IDE Library Manager](res/library-manager.jpg) + ![Type "MIDI" in the Arduino IDE Library Manager](res/library-manager.jpg) 2. Start coding: - ```c++ - #include - // Created and binds the MIDI interface to the default hardware Serial port - MIDI_CREATE_DEFAULT_INSTANCE(); + ```c++ + #include - void setup() - { - MIDI.begin(MIDI_CHANNEL_OMNI); // Listen to all incoming messages - } + // Created and binds the MIDI interface to the default hardware Serial port + MIDI_CREATE_DEFAULT_INSTANCE(); - void loop() - { - // Send note 42 with velocity 127 on channel 1 - MIDI.sendNoteOn(42, 127, 1); + void setup() + { + MIDI.begin(MIDI_CHANNEL_OMNI); // Listen to all incoming messages + } - // Read incoming messages - MIDI.read(); - } + void loop() + { + // Send note 42 with velocity 127 on channel 1 + MIDI.sendNoteOn(42, 127, 1); + + // Read incoming messages + MIDI.read(); + } ``` 3. Read the [documentation](#documentation) or watch the awesome video tutorials from [Notes & Volts](https://www.youtube.com/playlist?list=PL4_gPbvyebyH2xfPXePHtx8gK5zPBrVkg). ## Documentation -- [Doxygen Extended Documentation](http://fortyseveneffects.github.io/arduino_midi_library/). -- [GitHub wiki](https://github.com/FortySevenEffects/arduino_midi_library/wiki). +- [Doxygen Extended Documentation](https://fortyseveneffects.github.io/arduino_midi_library/). +- [GitHub wiki](https://github.com/FortySevenEffects/arduino_midi_library/wiki). ## Contact To report a bug, contribute, discuss on usage, or simply request support, please [create an issue here](https://github.com/FortySevenEffects/arduino_midi_library/issues/new). -You can also get informations about bug fixes and updates on my twitter account: [@fortysevenfx](http://twitter.com/fortysevenfx). +You can also contact me on Twitter: [@fortysevenfx](https://twitter.com/fortysevenfx). ## License -MIT © 2016 [Francois Best](http://fortyseveneffects.com) +MIT © 2009 - present [Francois Best](https://francoisbest.com)