diff --git a/README.md b/README.md index 76cead1..45d908a 100644 --- a/README.md +++ b/README.md @@ -50,33 +50,40 @@ void loop() 3. Read the [documentation](#documentation) or watch the awesome video tutorials from [Notes & Volts](https://www.youtube.com/playlist?list=PL4_gPbvyebyH2xfPXePHtx8gK5zPBrVkg). -## USB Migration +## Documentation + +- [Doxygen Extended Documentation](https://fortyseveneffects.github.io/arduino_midi_library/). +- [GitHub wiki](https://github.com/FortySevenEffects/arduino_midi_library/wiki). + +## USB Migration (4.x to 5.x) All USB related code has been moved into a separate repository [Arduino-USB-MIDI](https://github.com/lathoub/Arduino-USBMIDI), USB MIDI Device support with [`MIDIUSB`](https://github.com/arduino-libraries/MIDIUSB), still using this library to do all the MIDI heavy-lifting. -Migration has been made as easy as possible: only the declaration of the MIDI object has been modified, the code remains identical. +Migration has been made as easy as possible: only the declaration of the MIDI object has been modified, the rest of your code remains identical. `4.3.1` code: ```c++ - #include - #include - - static const unsigned sUsbTransportBufferSize = 16; - typedef midi::UsbTransport UsbTransport; - - UsbTransport sUsbTransport; - - MIDI_CREATE_INSTANCE(UsbTransport, sUsbTransport, MIDI); - ... +#include +#include + +static const unsigned sUsbTransportBufferSize = 16; +typedef midi::UsbTransport UsbTransport; + +UsbTransport sUsbTransport; + +MIDI_CREATE_INSTANCE(UsbTransport, sUsbTransport, MIDI); + +// ... ``` -become in `5.0.0` +now becomes in `5.0.0`: ```c++ - #include - USBMIDI_CREATE_DEFAULT_INSTANCE(); - ... +#include +USBMIDI_CREATE_DEFAULT_INSTANCE(); + +// ... ``` Start with the [NoteOnOffEverySec](https://github.com/lathoub/Arduino-USBMIDI/blob/master/examples/NoteOnOffEverySec/NoteOnOffEverySec.ino) example that is based on the original MidiUSB [sketch](https://github.com/lathoub/arduino_midi_library/blob/master/examples/MidiUSB/MidiUSB.ino). Note the only difference is in the declaration. @@ -85,21 +92,19 @@ The [USB-MIDI](https://github.com/lathoub/Arduino-USBMIDI) Arduino library depen [USB-MIDI](https://github.com/lathoub/Arduino-USBMIDI) uses the latest Arduino IDE `depends` feature in the `library.properties` file installing all the dependencies automatically when installing from the IDE. -## Other Transportation mechanisms +## Other Transport mechanisms -Version 5 of this library, allows for other Transportation layers than the original MIDI 1.0 Electrical Specification. +Version 5 of this library, allows for other Transport layers than the +original MIDI 1.0 Electrical Specification (hardware serial). - - [USB-MIDI](https://github.com/lathoub/Arduino-USBMIDI) - - [AppleMIDI or rtpMIDI](https://github.com/lathoub/Arduino-AppleMIDI-Library) - - [ipMIDI](https://github.com/lathoub/Arduino-ipMIDI) - - [BLE-MIDI](https://github.com/lathoub/Arduino-BLE-MIDI) +- [USB-MIDI](https://github.com/lathoub/Arduino-USBMIDI) +- [AppleMIDI or rtpMIDI](https://github.com/lathoub/Arduino-AppleMIDI-Library) +- [ipMIDI](https://github.com/lathoub/Arduino-ipMIDI) +- [BLE-MIDI](https://github.com/lathoub/Arduino-BLE-MIDI) -All these Transportation layers use this library for all the underlying MIDI work, making it easy to switch transport protocols or making transport protocol bridges. - -## Documentation - -- [Doxygen Extended Documentation](https://fortyseveneffects.github.io/arduino_midi_library/). -- [GitHub wiki](https://github.com/FortySevenEffects/arduino_midi_library/wiki). +All these Transport layers use this library for all the underlying MIDI +work, making it easy to switch transport protocols or making transport +protocol bridges. ## Contact