Changed folder structure and Updated README.md

alkaes · Sep 21, 2020 · 8ddf4e8 · 8ddf4e8
1 parent a108c84
commit 8ddf4e8
Show file tree

Hide file tree

Showing 13 changed files with 34 additions and 663 deletions.
diff --git a/QidiPrint/ChituCodeWriter.py → ChituCodeWriter.py b/QidiPrint/ChituCodeWriter.py → ChituCodeWriter.py
diff --git a/QidiPrint/LICENSE b/QidiPrint/LICENSE
diff --git a/QidiPrint/QidiPrintOutputDevice.py → QidiPrintOutputDevice.py b/QidiPrint/QidiPrintOutputDevice.py → QidiPrintOutputDevice.py
diff --git a/QidiPrint/QidiPrintPlugin.py → QidiPrintPlugin.py b/QidiPrint/QidiPrintPlugin.py → QidiPrintPlugin.py
diff --git a/QidiPrint/QidiPrintPlugin.qml → QidiPrintPlugin.qml b/QidiPrint/QidiPrintPlugin.qml → QidiPrintPlugin.qml
diff --git a/README.md b/README.md
@@ -8,12 +8,44 @@ with Cura not running, unpack the zip file from the
 [release](https://github.com/alkaes/QidiPrint/releases/latest) to this
 specific folder:
 
-`C:\Users\<username>\AppData\Roaming\cura\4.6\plugins\QidiPrintPlugin`
+`C:\Users\<username>\AppData\Roaming\cura\4.7\plugins\QidiPrint`
 
+Be careful, the unzipper often tacks on the name of the zip as a folder at the
+bottom and you don't want it nested.  You want the files to show up in that
+folder.
+
+Make sure that the plugin folder name is a listed above and it does not have
+any trailing version numbers (`-1.0.0`) or similar.
+
+## Configuration
+
+**Do NOT try to add a new "networked printer"!** This is only for Ultimaker printers.
+
+QIDI printers are configured through the extension menu bar:
+
+* Start Cura
+* From the menu bar choose: Extensions -> QidiPrint -> QidiPrint Connections
+
+![Screenshot of the menu bar entry](/screenshots/menu-bar.png)
+
+* Click "Add"
+
+![Screenshot of the edit dialog](/screenshots/edit-dialog.png)
+
+* Enter the name of your printer
+  - e.g., `X-MAKER`
+* Enter the IP of your printer
+  - e.g., `192.168.10.205`
+* Click "Ok"
+* Done!
+
+Now you can load a model and slice it. Then look at the bottom right - there
+should be the big blue button with you printer name on it!
 
 ## License
 
 This project is using code from:
-* https://github.com/Spanni26/ChituCodeWriter
 * https://github.com/Kriechi/Cura-DuetRRFPlugin
+* https://github.com/Spanni26/ChituCodeWriter
+
 
diff --git a/QidiPrint/UploadFilename.qml → UploadFilename.qml b/QidiPrint/UploadFilename.qml → UploadFilename.qml
diff --git a/QidiPrint/VC_compress_gcode.exe → VC_compress_gcode.exe b/QidiPrint/VC_compress_gcode.exe → VC_compress_gcode.exe
diff --git a/QidiPrint/__init__.py → __init__.py b/QidiPrint/__init__.py → __init__.py
diff --git a/QidiPrint/plugin.json → plugin.json b/QidiPrint/plugin.json → plugin.json
diff --git a/screenshots/edit-dialog.png b/screenshots/edit-dialog.png
diff --git a/screenshots/menu-bar.png b/screenshots/menu-bar.png
diff --git a/screenshots/print-button.png b/screenshots/print-button.png