Skip to content

Commit

Permalink
docs: Contributions
Browse files Browse the repository at this point in the history
  • Loading branch information
franky47 committed Apr 20, 2020
1 parent d600656 commit 5e9a016
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
15 changes: 13 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 ..
Expand Down
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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)

0 comments on commit 5e9a016

Please sign in to comment.