jonathanwin · Spiritdude · Mar 5, 2019 · Apr 12, 2021 · Apr 12, 2021 · Apr 12, 2021
diff --git a/CHANGELOG b/CHANGELOG
@@ -0,0 +1,24 @@
+0.5.8:
+  - support added for G2/G3 arc extrusions as used by ArcWelder
+  - CHANGELOG added
+
+0.5.4: 
+  - adding --help and --dark CLI options
+
+0.5.3:
+  - significant improvement to support non-planar slices
+  - parsing type of extrusion (wall/perimeters, support, infill etc), better support for Cura, Slic3r, PrusaSlicer and Mandoline 
+  - new mouse-button layout to match OpenSCAD
+  - LICENSE added
+
+0.5.2:
+   - new color scheme (white bg, green extrusion, red active layer), display layer# with z [mm]
+
+0.5.1:
+   - `setup.py` with proper pyglet version to match code (pre-2.0), drawing bed grid
+
+0.5.0: 
+  - Python3 support
+  - proper panning  
+
+
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,20 @@
+Copyright 2013-2017 Jonathan Winterflood
+Copyright 2021 by Rene K. Mueller
+
+Permission  is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"),  to  deal  in
+the  Software  without  restriction,  including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the  Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included  in  all
+copies or substantial portions of the Software.
+
+THE  SOFTWARE  IS  PROVIDED  "AS  IS",  WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR  A  PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER  LIABILITY,  WHETHER
+IN  AN  ACTION  OF  CONTRACT,  TORT  OR  OTHERWISE,  ARISING  FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
diff --git a/Makefile b/Makefile
@@ -0,0 +1,32 @@
+APPNAME = yagv
+VERSION = 0.5.8
+# check setup.py and ./yagv too
+
+all::
+	@echo "make install deinstall"
+
+install::
+	python3 setup.py install
+	sudo mkdir -p /usr/local/share/yagv;
+	sudo tar cf - icon.png data | (cd /usr/local/share/yagv/; sudo tar xf -)
+	#cp yagv.desktop ~/.local/share/applications/
+	sudo cp yagv.desktop /usr/share/applications/
+
+deinstall::
+
+# -- devs only:
+
+edit::
+	dee4 yagv gcodeParser.py Makefile tests/Makefile README.md setup.py
+
+change::
+	git commit -am "..."
+
+push::
+	git push origin master
+
+pull::
+	git pull
+
+backup::
+	cd ..; tar cfvz ~/Backup/${APPNAME}-${VERSION}.tar.gz ${APPNAME}; scp ~/Backup/${APPNAME}-${VERSION}.tar.gz backup:Backup/
diff --git a/README.md b/README.md
@@ -1,38 +1,76 @@
-# yagv - Yet Another Gcode Viewer, v0.4
+# yagv - Yet Another Gcode Viewer, v0.5.8
 
-A fast 3D Gcode Viewer for Reprap-style 3D printers, in Python and OpenGL (via pyglet)
+A fast 3D Gcode Viewer for Reprap-style 3D printers, in Python and OpenGL/pyglet
 
-Designed in Ubuntu Linux; Expected to work in any Linux, Windows or OS X
+![Screenshot](img/screenshot.png)
 
-## Requires:
+## Features
 
-* python 2.x (2.7.3 tested)
-  http://python.org/
-* pyglet 1.1+ (1.1.4 tested)
-  http://www.pyglet.org
+* Colors segments according to their type:
+  * extruding (wall, infill, support if G-code comments are enabled in slicer)
+  * motion of the head to the next extrusion point
+  * retracting filament
+  * restoring filament
+* Allows displaying layers independently to examine them (scroll up & down)
+* Automagically splits the Gcode into layers
+* Automatic scaling to fit the window
+* Zoom, panning and rotation (same mouse-button layout as OpenSCAD)
+* Supported slicers:
+  * [Slic3r](https://slic3r.org/) 1.2.9: works
+  * [PrusaSlicer](https://www.prusa3d.com/prusaslicer/) 2.1.1: works
+  * [Cura](https://ultimaker.com/software/ultimaker-cura) 4.x: works
+  * [Mandoline](https://github.com/Spiritdude/mandoline-py) 0.8.x: works
+  * [Slicer4RTN](https://github.com/Spiritude/Slicer4RTN) 0.4.x: works (non-planar slices)
+* Day/Night mode (`--dark`)
+
+## Supported Platforms
+- Ubuntu Linux 20.04 LTS [confirmed]
+- Expected to work in any Linux, Windows or macOS
 
-## Usage:
+## Installation
+```
+% python3 setup.py install
+ - OR -
+% sudo python3 setup.py install
+```
 
-yagv [file.gcode]
-* By default, open data/hana_swimsuit_fv_solid_v1.gcode if no file specified
+## Usage
 
-## Features:
+```
+% yagv [file.gcode]
 
-* Colors segments according to their type:
-  * extruding
-  * flying the head to the next extrusion point
-  * retracting filament
-  * restoring filament
-* Allows displaying layers independently to examine them.
-* Automagically splits the gcode into layers.
-* Automatic scaling to fit the window.
-* Zoom and rotation (Panning planned).
+% yagv --help
+USAGE yagv 0.5.4: [<opts>] file.gcode
+   options:
+      --help               display this message
+      --dark               enable dark mode
+      --bed-size=<w>x<h>   set bed size (e.g. 200x240)
+                     
+```
+By default, opens `data/hana_swimsuit_fv_solid_v1.gcode` if no file specified
 
-## Issues:
+## Issues
 
-* Panning for close inspection not yet supported.
+* ~~Zoom & Panning don't work well together, zoom in/out changes focus center~~ resolved in 0.5.3
 * Retract/restore detected but invisible (0-length segments).
-* Designed with Slic3r output in mind, may not support other slicing programs (suggestions/patches welcome).
-* Some gcodes unsupported, in particular:
-  * G20: Set Units to Inches (usage unknown) 
-  * Arcs (G2 & G3 ?)
+* Some GCodes unsupported, in particular:
+  * G20: Set Units to Inches
+  * ~~G2 & G3: Arcs~~ resolved in 0.5.8
+
+## Changes
+* 0.5.8: support added for G2/G3 arc extrusions as used by ArcWelder, CHANGELOG added
+* 0.5.4: better parsing arguments, adding `--dark` mode added
+* 0.5.3: better support for Cura, Slic3r, PrusaSlicer and Mandoline distincting perimeter/wall/shell, infill and support extrusion (e.g. `;TYPE:...` Gcode comments); new mouse-button layout to match OpenSCAD
+* 0.5.2: new color scheme (white bg, green extrusion, red active layer), display layer# with z [mm]
+* 0.5.1: `setup.py` with proper pyglet version to match code (pre-2.0), drawing bed grid
+* 0.5.0: ported to Python3, added panning, smaller font
+
+## More Examples
+### Support Structure
+![Screenshot](img/screenshot-support.png)
+Given `--gcode-comments` is enabled for Slic3r and PrusaSlicer.
+
+### Non-Planar Slices
+![Screenshot](img/screenshot-nonplanar.png)
+Gcode from [Slicer4RTN](https://github.com/Spiritdude/Slicer4RTN), conic/tilted slicer for 4- and 5-axis FDM printers
+
diff --git a/__init__.py b/__init__.py