Merge pull request #2 from timmehtimmeh/develop

Merge develop into Master since Cura 3.2 is officially released

README.md

@@ -1,9 +1,9 @@
 # Cura-Dremel-3D20-Plugin
-Dremel Ideabuilder 3D20 plugin for [Ultimaker Cura](https://ultimaker.com/en/products/ultimaker-cura-software) versions 3.0 and 3.1 (see note below for Cura 3.2 compatibility).  This plugin enables the user to export the proprietary .g3drem files using Cura.  This code is **heavily** based upon the [cura gcode writer plugin](https://github.com/Ultimaker/Cura/tree/master/plugins/GCodeWriter) and has been hacked together in an afternoon.  Although the software functions reasonably well for the author, the author will not guarantee that the software won't break your 3d printer, set it on fire, or do other really bad things.  The software is supplied without warranty and the user is responsible if they use this software and bad things happen either to their person, their 3d printer, or any of their other propery as a result of using this software, or the files that it creates.  Please remain near the 3D printer while using files generated by this software, and pay close attention to the 3D printer to verify that the machine is functioning properly. The software is provided as-is and any usage of this software or its output files is strictly at the user's own risk.
+Dremel Ideabuilder 3D20 plugin for [Cura version 3.2](https://ultimaker.com/en/products/ultimaker-cura-software) or greater. This plugin enables the user to export the proprietary .g3drem files using Cura.  This code is **heavily** based upon the [cura gcode writer plugin](https://github.com/Ultimaker/Cura/tree/master/plugins/GCodeWriter) and has been hacked together in an afternoon.  Although the software functions reasonably well for the author, the author will not guarantee that the software won't break your 3d printer, set it on fire, or do other really bad things.  The software is supplied without warranty and the user is responsible if they use this software and bad things happen either to their person, their 3d printer, or any of their other propery as a result of using this software, or the files that it creates.  Please remain near the 3D printer while using files generated by this software, and pay close attention to the 3D printer to verify that the machine is functioning properly. The software is provided as-is and any usage of this software or its output files is strictly at the user's own risk.
 
 ![The Cura GUI](/docs/GUI.PNG)
 
-**Note:** This version of the Cura-Dremel-3D20-Plugin will only work with Cura versions 3.1 or earlier due to changes that Ultimaker implemented in the Cura architecture for Cura 3.2. For a version that works with Cura versions 3.2, please check out the [develop branch](https://github.com/timmehtimmeh/Cura-Dremel-3D20-Plugin/tree/develop) instead of the master branch.
+**Note:**  This version of the Cura-Dremel-3D20-Plugin will not work with Cura versions 3.1 or earlier due to changes that Ultimaker implemented in the Cura architecture.  For a version that works with Cura versions 3.0 or 3.1, please check out version 0.2.5 of the plugin [here](https://github.com/timmehtimmeh/Cura-Dremel-3D20-Plugin/releases/tag/0.2.5)
 
 ---
 # Installation
@@ -60,15 +60,17 @@ If successful, you should see the test `***Plugin Successfully installed` then s
 3.  Install the main plugin that enables Cura to export .g3drem files by following the instructions below:
 
     EITHER
-    1. Install the DremelGCodeWriter.umplugin located at `Cura-Dremel-3D20-Plugin\plugins\DremelGCodeWriter.umplugin` using Cura's plugin install interface (Cura Menu->Plugins->Install Plugin)  **Note:**  On Windows this method installs the plugin to `%OS_USER_DIR%\AppData\Roaming\cura\%CURA VERSION%\plugins`.  For specific directories for other Operating Systems please see [this page](https://github.com/Ultimaker/Cura/wiki/Cura-Preferences-and-Settings-Locations)
+
+    1. Install the DremelGCodeWriter.umplugin located at `Cura-Dremel-3D20-Plugin\plugins\DremelGCodeWriter.umplugin` using Cura's plugin install interface (Cura Menu->Plugins->Install Plugin)  **Note:**  On Windows this method installs the plugin to `%OS_USER_DIR%\AppData\Roaming\cura\%CURA VERSION%\plugins`.  For Operating System specific directories of where Cura installs plugins please see [this page](https://github.com/Ultimaker/Cura/wiki/Cura-Preferences-and-Settings-Locations)
+
 
     OR
 
     2. Copy the plugins/DremelGCodeWriter folder into your `%CURA_DIR%/plugins` folder.  On MacOS this is located at `Ultimaker Cura.app/Contents/Resources/plugins/plugins/`  The easiest way on the mac to get to this folder is to right click on the Ultimaker Cura.app application and select the "show package contents" option.
 
     ![Copy the contents of DremelOutputDevice to the plugin directory of cura](/docs/plugindir.PNG)
 
-  For a minimal installation this is all you need.  Feel free to skip the following steps if you don't care about specific settings for the Dremel3D20 and only want to export .g3drem files from cura (Note: a minimal installation won't necessarily set up the print bed size, machine speeds, etc... correctly and the user is responsible for ensuring that the print settings are correct and that the print will fit on the bed)
+  For a minimal installation this is all you need.  Feel free to skip the following steps if you don't care about specific settings for the Dremel3D20 and only want to export .g3drem files from cura (Note: a minimal installation won't necessarily set up the print bed size, machine speeds, etc... correctly and the user is responsible for ensuring that the print settings are correct and that the print will fit on the bed)  The minimal installation *should* work, but has not been tested, and no guarantees are made.
 
   **For a complete installation complete steps 4-6:**
 
@@ -141,6 +143,7 @@ The following items would be great to add to this plugin - as I get time I'll wo
 * Better understanding of the remaining unknown items in the Dremel .g3drem file format
 * ~~Support for Dremel brand PLA in Dremel3D20.def.json file~~
 * Optimization of Dremel brand PLA settings
+* Creation of plugin container with Dremel printer json, material json, and printer bed mesh to ease installation
 ---
 # <a name="Technical_Details"></a>Technical Details of the .g3drem File Format
 The g3drem file format consists of a few sections.  The header is a mix of binary data and ASCII data, which is followed by an 80x60 pixel bitmap image written to the file, which is then followed by standard 3d printer gcode saved in ASCII format.