Seich
/
arduino_midi_library
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Contributions

This commit is contained in:
Francois Best 2020-04-20 17:30:03 +02:00
parent d600656f04
commit 5e9a0165d9
2 changed files with 30 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -1,18 +1,29 @@
# Contributing Guidelines
First, thanks for your help ! :+1:
## Branches
Please base your Pull Requests off the `master` branch.
## Requirements ## Requirements
Requirements to build and run the unit tests: Requirements to build and run the unit tests:
- CMake 2.8 or later - CMake 2.8 or later
- GCC / Clang with C++11 support - GCC / Clang with C++11 support (GCC 4.8 or higher)
## Setup ## Setup
Pull Google Test / Google Mock subrepository: Pull Google Test / Google Mock subrepository:
``` ```
$ git submodule init $ git submodule init
$ git submodule update $ git submodule update
``` ```
Create build directory, run CMake, build and run unit tests: Create build directory, run CMake, build and run unit tests:
``` ```
$ mkdir build && cd build $ mkdir build && cd build
$ cmake .. $ cmake ..

18
README.md
View File

@ -9,7 +9,8 @@ This library adds MIDI I/O communications to an Arduino board.
### Features ### Features
- **New** : USB MIDI Device support with [`MIDIUSB`](https://github.com/arduino-libraries/MIDIUSB). - **New** : MIDI over USB, Bluetooth & IP (see [Transports](#other-transport-mechanisms)).
- **New** : Active Sensing support
- Compatible with all Arduino boards (and clones with an AVR processor). - 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..). - 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). - OMNI input reading (read all channels).
@ -112,6 +113,21 @@ To report a bug, contribute, discuss on usage, or simply request support, please
You can also contact me on Twitter: [@fortysevenfx](https://twitter.com/fortysevenfx). You can also contact me on Twitter: [@fortysevenfx](https://twitter.com/fortysevenfx).
## Contributors
Special thanks to all who have contributed to this open-source project !
- [@lathoub](https://github.com/lathoub)
- [@jarosz](https://github.com/jarosz)
- [@ivankravets](https://github.com/ivankravets)
- [@insolace](https://github.com/insolace)
- [@softegg](https://github.com/softegg)
- [@per1234](https://github.com/per1234)
- [@LnnrtS](https://github.com/LnnrtS)
- [@DavidMenting](https://github.com/DavidMenting)
You want to help ? Check out the [contribution guidelines](./CONTRIBUTING.md).
## License ## License
MIT © 2009 - present [Francois Best](https://francoisbest.com) MIT © 2009 - present [Francois Best](https://francoisbest.com)