diff --git a/README.md b/README.md index 04f0bde..4b468ea 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ -BigKnob +# J6 Bigknob +This is the main firmware for the J6 Bigknob USB-MIDI controller, based on the Teensy platform (Arduino Compatable) + +## Features +- 4x Keyswitches +- 2x Rotary Encoders +- 1x 3 way switch +- 1x 3.5mm TRS Jack for footpedal + +![](https://cdn.discordapp.com/attachments/482884573135503370/482888428044943381/rgaOo9U1TDLpLdNC4_3uMpx7DCtixzYFruvnIrGRShJIKIc-jn5q7nXfX4isUhQsIJ9C4SKxvwztoHafofvVJ4Le0yZ-612s74Rd.png = 250x250 ) + +## Usage + +Download + extract the repo to a local folder. +##### Windows +------------ +** Via Git** + [Download Git for Windows](https://git-scm.com/download/win "Download Git for Windows") + Then via command line / powershell +` D:\Arduino> git clone https://github.com/litruv/BigKnob.git BigKnob` + +##### MacOS +------------ +[Download Git fot MacOS](https://git-scm.com/download/mac "Download Git fot MacOS") + Then via terminal +` $ git clone https://github.com/litruv/BigKnob.git BigKnob` + +##### Linux +------------ +`$ git clone https://github.com/litruv/BigKnob.git BigKnob` + +##### General +------------ +[![Download Repo Zip](https://i.imgur.com/Ij76c4Q.png "Download Repo Zip")](https://i.imgur.com/Ij76c4Q.png "Download Repo Zip") + +