diff --git a/Readme.md b/Readme.md index d65b616..db6fe94 100644 --- a/Readme.md +++ b/Readme.md @@ -1,6 +1,16 @@ +# Arduino Joystick library This is a library that builds and sends USB HID Joystick reports, making it easy to build USB Joysticks with Arduino. -Dependencies: - +## Dependencies * Your Arduino's USB communication chip be programmed with the arduino-big-joystick firmware (or similar). See for more info. * The Bounce2 library, available at . + +## Installation +1. Put the arduino-joystick directory into your Arduino libraries directory. +2. Make sure Bounce2 is installed! +3. In your arduino sketch, add the includes: + #include + #include +4. Create a Joystick object: + Joystick joystick; +5. Add buttons and axes in setup() with Joystick::AddButton(), and call Joystick::Update() in loop(). That's it!