Skip to content

Commit b3ab309

Browse files
committed
doc: Update Readme
Fix typos, add USB support
1 parent faa7bad commit b3ab309

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

README.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,47 +5,48 @@
55
[![GitHub release](https://img.shields.io/github/release/FortySevenEffects/arduino_midi_library.svg?maxAge=3600)](https://github.com/FortySevenEffects/arduino_midi_library/releases/latest)
66
[![License](https://img.shields.io/github/license/FortySevenEffects/arduino_midi_library.svg?maxAge=3600)](LICENSE)
77

8-
This library enables MIDI I/O communications on the Arduino serial ports.
8+
This library adds MIDI I/O communications to an Arduino board.
99

1010
### Features
1111

12+
- **New** : USB MIDI Device support with [`MIDIUSB`](https://github.com/arduino-libraries/MIDIUSB).
1213
- Compatible with all Arduino boards (and clones with an AVR processor).
1314
- Simple and fast way to send and receive every kind of MIDI message (including all System messages, SysEx, Clock, etc..).
1415
- OMNI input reading (read all channels).
1516
- Software Thru, with message filtering.
1617
- [Callbacks](https://github.com/FortySevenEffects/arduino_midi_library/wiki/Using-Callbacks) to handle input messages more easily.
1718
- Last received message is saved until a new one arrives.
1819
- Configurable: [overridable template-based settings](https://github.com/FortySevenEffects/arduino_midi_library/wiki/Using-custom-Settings).
19-
- Create more than one MIDI port for mergers/splitters applications.
20+
- Create more than one MIDI interface for mergers/splitters applications.
2021
- Use any serial port, hardware or software.
2122

2223
### Getting Started
2324

24-
1. Use Arduino's Library Manager to install the library.
25+
1. Use the Arduino Library Manager to install the library.
2526
![Type "MIDI" in the Arduino IDE Library Manager](res/library-manager.jpg)
2627

2728
2. Start coding:
2829

29-
```c++
30-
#include <MIDI.h>
30+
```c++
31+
#include <MIDI.h>
3132

32-
// Created and binds the MIDI interface to the default hardware Serial port
33-
MIDI_CREATE_DEFAULT_INSTANCE();
33+
// Create and bind the MIDI interface to the default hardware Serial port
34+
MIDI_CREATE_DEFAULT_INSTANCE();
3435

35-
void setup()
36-
{
37-
MIDI.begin(MIDI_CHANNEL_OMNI); // Listen to all incoming messages
38-
}
36+
void setup()
37+
{
38+
MIDI.begin(MIDI_CHANNEL_OMNI); // Listen to all incoming messages
39+
}
3940

40-
void loop()
41-
{
42-
// Send note 42 with velocity 127 on channel 1
43-
MIDI.sendNoteOn(42, 127, 1);
41+
void loop()
42+
{
43+
// Send note 42 with velocity 127 on channel 1
44+
MIDI.sendNoteOn(42, 127, 1);
4445

45-
// Read incoming messages
46-
MIDI.read();
47-
}
48-
```
46+
// Read incoming messages
47+
MIDI.read();
48+
}
49+
```
4950

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

0 commit comments

Comments
 (0)