Add more documentation and create a proper release package with extra…

… library and dependencies

.gitignore

@@ -258,4 +258,5 @@ paket-files/
 
 # Python Tools for Visual Studio (PTVS)
 __pycache__/
-*.pyc
+*.pyc
+LEETArduinoPendantRelease.zip

LEETArduinoPendantRelease/REDME.md

@@ -0,0 +1,19 @@
+
+# LEETArduinoPendant
+A UCCNC Plugin to receive commands from an Arduino Nano-powered CNC Pendant
+Uses Solid.Arduino library to talk to Arduino Nano
+
+## The full list of components, pictures and videos used can be found here:
+https://zero-divide.net/?article_id=5319_custom-cnc-pendant-project
+
+## Arduino Setup
+* Install the Full Firmata library onto your Arduino Nano
+
+## UCCNC Setup
+* Download the latest LEETArduinoPendant from the releases and extract it to your PC.
+* Copy the `LEETArduinoPendant.dll` plugin file to the C:\UCCNC\Plugins directory!
+* Copy the `Solid.Arduino.dll` file from the `Solid.Arduino` release folder to the C:\UCCNC directory.
+* Please note that you might need to install `Arduino USB Driver` in order for your Arduino to work on the target computer!
+* Launch UCCNC.exe, go to `Settings->Configure Plugins`, and mark the `LEET Arduino Pendant` plugin as `Enabled` and `Call startup`
+* After everything is installed, Arduino is connected and UCCNC is running, press the "Enable" (+5v to D2-B-ENABLE ) button that will tell the plugin that the pendant is ready to send signals!
+D13 (LED+) will then have a continuous +3.3V signal alerting you of that!

LEETArduinoPendantRelease/Solid.Arduino/LICENSE.md

@@ -0,0 +1,11 @@
+####Copyright (c) 2013 - 2015, Henk van Boeijen <[email protected]>
+
+#####All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.