diff --git a/CHANGELOG.md b/CHANGELOG.md index bf04455..e51580d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +# 1.0.2 (2024-01-10) +- better documentation + # 1.0.1 (2024-01-10) - Added animated screenshot how-to diff --git a/README.md b/README.md index d853d60..c7ff057 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,4 @@ A web-based editor to configure [Push Push](https://github.com/garubi/push-push) Use it at (https://garubi.github.io/push-push-editor/) -![A screenshot of the editor](animated-preview.gif) \ No newline at end of file +![A screenshot of the editor](/docs/images/animated-preview.gif) \ No newline at end of file diff --git a/animated-preview.gif b/animated-preview.gif deleted file mode 100644 index 0d032c6..0000000 Binary files a/animated-preview.gif and /dev/null differ diff --git a/animated-preview.stg b/animated-preview.stg index f5d5e7f..f4c0ddc 100644 Binary files a/animated-preview.stg and b/animated-preview.stg differ diff --git a/docs/images/animated-preview.gif b/docs/images/animated-preview.gif new file mode 100644 index 0000000..6bebff2 Binary files /dev/null and b/docs/images/animated-preview.gif differ diff --git a/docs/index.html b/docs/index.html index 53bac0b..56db2ea 100644 --- a/docs/index.html +++ b/docs/index.html @@ -61,17 +61,17 @@

Use this web app for the configuration of Push Push, a DIY device that you can easily build with Arduino (See here).
- Push Push provides a number of buttons (or pedals) and, by connecting is to your computer with an USB cable, it allows you to send keystorkes and keys combinations to your computer's programs.
- This editor is for setting the keys combination that each button of the Push Push sends to your computer. + Push Push is a very easy to build device (based on Arduino) that allows you to send keystrokes to a computer by emulating a USB keyboard. + This editor is for setting the keystrokes that each button of the Push Push sends to your computer.

How to use this editor

- (On the project homepage you can see a short how-to animation. Click here to open it in a new tab) +

  1. Connect your Push Push to the computer with the USB cable
  2. Open this web page (or reload it)
  3. The browser will ask you the permission to open and reconfigure your MIDI devices with SysEx.
    Consent to it (Sysex is the language we use to send configuration messages to Push Push)
    4. -
  4. Select your device from the dropdown.
    (Tipically the device is not named Push Push. It is named after the Arduino Board you used to build it, es: Arduino Leonardo. If you have other MIDI devices connected you'll see them to in the dropdown. Ignore them)
    5. +
  5. Select your device from the dropdown.
    (Tipically the device is not named Push Push. It is named after the Arduino Board you used to build it, es: Arduino Leonardo)
  6. Click Connect
  7. A table will appear with your buttons in each row and up to five keys dropdowns in columns. The first 4 keys are so called "modifiers": CTRL, ALT SHIFT etc.. The last column are letters and special keys. If your Push Push was already configured with some key, they will be preselected in the dropdowns
  8. Select the key combination you need for each button and click Store to send and save it to your Push Push
    9. diff --git a/docs/js/app.js b/docs/js/app.js index 38bb549..48b1d3c 100644 --- a/docs/js/app.js +++ b/docs/js/app.js @@ -1,4 +1,4 @@ -var editor_version = '1.0.1'; +var editor_version = '1.0.2'; var PP_MIDI_MANUF_ID_1 = 0x37; var PP_MIDI_MANUF_ID_2 = 0x72;