Skip to content

Commit 2d6bdd6

Browse files
committed
doc: Move Documentation section up
1 parent c2d17ec commit 2d6bdd6

File tree

1 file changed

+33
-28
lines changed

1 file changed

+33
-28
lines changed

README.md

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -50,33 +50,40 @@ void loop()
5050

5151
3. Read the [documentation](#documentation) or watch the awesome video tutorials from [Notes & Volts](https://www.youtube.com/playlist?list=PL4_gPbvyebyH2xfPXePHtx8gK5zPBrVkg).
5252

53-
## USB Migration
53+
## Documentation
54+
55+
- [Doxygen Extended Documentation](https://fortyseveneffects.github.io/arduino_midi_library/).
56+
- [GitHub wiki](https://github.com/FortySevenEffects/arduino_midi_library/wiki).
57+
58+
## USB Migration (4.x to 5.x)
5459

5560
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.
5661

57-
Migration has been made as easy as possible: only the declaration of the MIDI object has been modified, the code remains identical.
62+
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.
5863

5964
`4.3.1` code:
6065

6166
```c++
62-
#include <MIDI.h>
63-
#include <midi_UsbTransport.h>
64-
65-
static const unsigned sUsbTransportBufferSize = 16;
66-
typedef midi::UsbTransport<sUsbTransportBufferSize> UsbTransport;
67-
68-
UsbTransport sUsbTransport;
69-
70-
MIDI_CREATE_INSTANCE(UsbTransport, sUsbTransport, MIDI);
71-
...
67+
#include <MIDI.h>
68+
#include <midi_UsbTransport.h>
69+
70+
static const unsigned sUsbTransportBufferSize = 16;
71+
typedef midi::UsbTransport<sUsbTransportBufferSize> UsbTransport;
72+
73+
UsbTransport sUsbTransport;
74+
75+
MIDI_CREATE_INSTANCE(UsbTransport, sUsbTransport, MIDI);
76+
77+
// ...
7278
```
7379
74-
become in `5.0.0`
80+
now becomes in `5.0.0`:
7581
7682
```c++
77-
#include <USB-MIDI.h>
78-
USBMIDI_CREATE_DEFAULT_INSTANCE();
79-
...
83+
#include <USB-MIDI.h>
84+
USBMIDI_CREATE_DEFAULT_INSTANCE();
85+
86+
// ...
8087
```
8188

8289
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
8592

8693
[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.
8794

88-
## Other Transportation mechanisms
89-
90-
Version 5 of this library, allows for other Transportation layers than the original MIDI 1.0 Electrical Specification.
95+
## Other Transport mechanisms
9196

92-
- [USB-MIDI](https://github.com/lathoub/Arduino-USBMIDI)
93-
- [AppleMIDI or rtpMIDI](https://github.com/lathoub/Arduino-AppleMIDI-Library)
94-
- [ipMIDI](https://github.com/lathoub/Arduino-ipMIDI)
95-
- [BLE-MIDI](https://github.com/lathoub/Arduino-BLE-MIDI)
97+
Version 5 of this library, allows for other Transport layers than the
98+
original MIDI 1.0 Electrical Specification (hardware serial).
9699

97-
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.
100+
- [USB-MIDI](https://github.com/lathoub/Arduino-USBMIDI)
101+
- [AppleMIDI or rtpMIDI](https://github.com/lathoub/Arduino-AppleMIDI-Library)
102+
- [ipMIDI](https://github.com/lathoub/Arduino-ipMIDI)
103+
- [BLE-MIDI](https://github.com/lathoub/Arduino-BLE-MIDI)
98104

99-
## Documentation
100-
101-
- [Doxygen Extended Documentation](https://fortyseveneffects.github.io/arduino_midi_library/).
102-
- [GitHub wiki](https://github.com/FortySevenEffects/arduino_midi_library/wiki).
105+
All these Transport layers use this library for all the underlying MIDI
106+
work, making it easy to switch transport protocols or making transport
107+
protocol bridges.
103108

104109
## Contact
105110

0 commit comments

Comments
 (0)