summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md30
1 files changed, 28 insertions, 2 deletions
diff --git a/README.md b/README.md
index bf21e46..3c2b31a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
1# launchpad-pro 1# Launchpad Pro
2Open source firmware for the Launchpad Pro grid controller 2Open source firmware for the Launchpad Pro grid controller!
3
4# Installation
5This project uses Vagrant to manage the build environment. As such, you need to:
6
71. Install Vagrant
82. Install VirtualBox (or another virtualisation platform of your choice)
93. vagrant up
10
11# Building
12SSH into the Vagrant "box" by doing `vagrant up
13At the command prompt, type `make
14
15This will generate the firmware .bin file, which is no use to you (yet).
16
17You need to convert it to a sysex dump format (or we may be able to automate this). Instructions to follow...
18
19# Uploading to a Launchpad Pro
20Bootloader firmware update instructions here (Sysex Librarian / MIDI-OX / ...?)
21
22# Debugging
23We decided not to support or encourage using a JLink or similar for debugging, as opening a Launchpad Pro to fit a debugging header can easily damage the FSR (force sensitive resistor) sheets.
24
25Instead, you're going to have to do things the old fashioned way - by blinking LEDs or sending MIDI messages.
26
27If you want to test code in detail, we suggest developing it on a host (we'd love to release our simulator environment at a later stage, but there are currently no plans to do so).
28