From 5e9a0165d9672f92316def2d755a26ed69dad0ce Mon Sep 17 00:00:00 2001 From: Francois Best Date: Mon, 20 Apr 2020 17:30:03 +0200 Subject: [PATCH] docs: Contributions --- CONTRIBUTING.md | 15 +++++++++++++-- README.md | 18 +++++++++++++++++- 2 files changed, 30 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b31956..de91ace 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,18 +1,29 @@ +# Contributing Guidelines + +First, thanks for your help ! :+1: + +## Branches + +Please base your Pull Requests off the `master` branch. + ## Requirements Requirements to build and run the unit tests: -- CMake 2.8 or later -- GCC / Clang with C++11 support + +- CMake 2.8 or later +- GCC / Clang with C++11 support (GCC 4.8 or higher) ## Setup Pull Google Test / Google Mock subrepository: + ``` $ git submodule init $ git submodule update ``` Create build directory, run CMake, build and run unit tests: + ``` $ mkdir build && cd build $ cmake .. diff --git a/README.md b/README.md index 45d908a..26f1837 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,8 @@ This library adds MIDI I/O communications to an Arduino board. ### 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). - 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). @@ -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). +## 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 MIT © 2009 - present [Francois Best](https://francoisbest.com)