Better documentation

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
 

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)
+![A screenshot of the editor](/docs/images/animated-preview.gif)

docs/index.html

@@ -61,17 +61,17 @@ <h2>
                 </h2>
                 <p>
                     Use this web app for the configuration of <a href="https://github.com/garubi/push-push" target="_blank" rel="noreferrer">Push Push</a>, a DIY device that you can easily build with Arduino (<a href="https://github.com/garubi/push-push" target="_blank" rel="noreferrer">See here</a>). <br>
-                    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.<br>
-                    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.
                 </p>
                 <h2>How to use this editor</h2>
                 <p>
-                    (<a href="https://github.com/garubi/push-push-editor" target="_blank" rel="noreferrer">On the project homepage you can see a short how-to animation. Click here to open it in a new tab</a>)
+                    <center><img src="images/animated-preview.gif" ></center>
                     <ol>
                         <li><b>Connect</b> your Push Push to the computer with the USB cable</li>
                         <li><a href="#"><b>Open  this web page</b> (or reload it)</a></li>
                         <li>The browser will ask you the permission to open and reconfigure your MIDI devices with SysEx.<br><b>Consent</b> to it (Sysex is the language we use to send configuration messages to Push Push)</li>
-                        <li><b>Select your device</b> from the dropdown.<br> (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)</li>
+                        <li><b>Select your device</b> from the dropdown.<br> (Tipically the device is not named Push Push. It is named after the Arduino Board you used to build it, es: <b>Arduino Leonardo</b>)</li>
                         <li><b>Click Connect</b></li>
                         <li>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</li>
                         <li><b>Select the key combination you need</b> for each button and <b>click Store</b> to send and save it to your Push Push</li>

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;