readme and install

Author: markfinn

build_requirements.txt

@@ -0,0 +1 @@
+pyinstaller==6.1.0

readme.md

@@ -0,0 +1,49 @@
+# What is this
+
+Converts a gcode file to all "G21" / metric / millimeters.
+    
+The Richauto A11/B11 controller on the wood shop "axion precision iconic" CNC routers don't work correctly with inch units. 
+    
+Without this post-processing script those controllers will read the G20 and use inches for X/Y/Z but NOT for the feed speed.  I'm not sure what it does about IJK.
+    
+This script works by replacing any G20 (inch) sections of the gcode with G21 (millimeter) versions of the numbers.  Command codes modified are A, B, C, F, I, J, K, R, U, V,
+    
+If no G20 is in your gcode, this script will not assume inches and it will do nothing.  You could add a G20 at the top of your code and try again.
+    
+Comments are currently lost in the output because I'm lazy.
+
+
+# Install
+I'm going to try to make releases that are precompiled, but until then:
+
+```bash
+git clone  [email protected]:Brown-County-FIRST-Robotics/MakeMetricGcode.git
+cd MakeMetricGcode
+python3 -m venv venv
+. venv/bin/activate
+pip install -r requirements.txt
+```
+
+# Run
+```bash
+python guimain.py 
+```
+
+
+# Build
+## Linux
+```bash
+. venv/bin/activate
+pip install -r build_requirements.txt
+python pyinstaller -F guimain.py -n make_metric_gcode
+```
+
+
+# Todo
+- [ ] build linux release
+- [ ] build windows release
+- [ ] build mac release
+- [ ] better GUI style: https://www.reddit.com/r/Python/comments/lps11c/how_to_make_tkinter_look_modern_how_to_use_themes/
+- [ ] stop using easygui or fix the extension ordering in file open and save dialog
+- [ ] ignore dot files: https://stackoverflow.com/questions/53220711/how-to-avoid-hidden-files-in-file-picker-using-tkinter-filedialog-askopenfilenam
+

requirements.txt

@@ -0,0 +1 @@
+easygui==0.98.3