Merge branch 'release/v1.3'

Author: panzergame

README.md

@@ -1,3 +1,7 @@
+<p align="center">
+	<img src="doc/logo.png"/>
+</p>
+
 # DXF Plotter
 
 > Fast and easy to use DXF to GCode converter for laser and router CNC
@@ -13,13 +17,20 @@ This application helps users converting DXF files to GCode with minimal settings
 It targets only laser and router CNC following every lines and arcs from DXF file with optional desired depth.
 
 
-## Features
+## ⚙ Features
 
 * DXF support of line, arc, circle, polyline, spline
 * Customizable GCode command format
+* Saving current work to file
 * Multi selected path setting edition
 * Path offseting (Tool Compensation)
+* Pocket generation with islands capabilities
 * Multi passes with depth
+* Scale and translate paths
+
+<p align="center">
+	<img src="doc/pocket.gif" width="80%"/>
+</p>
 
 ## Installation
 
@@ -34,22 +45,20 @@ chmod +x dxfplotter-*.AppImage
 ./dxfplotter-*.AppImage
 ```
 
-### Manual installation from source
+### 🏗 Manual installation from source
 
-This project depends on Qt5, yaml-cpp and fmt, for debian like distribution following command install all dependencies:
+This project depends on Qt5, for debian like distribution following command install all dependencies:
 
 ```sh
-sudo apt-get install qtbase5-dev libyaml-cpp-dev libfmt-dev
+sudo apt-get install qtbase5-dev
 ```
 
 ```sh
 git submodule init
 git submodule update
 
-mkdir build
-cd build
-cmake ..
-make
+cmake -B build
+cmake --build build -j $(nproc)
 ```
 
 ## Usage example
@@ -76,16 +85,15 @@ Once opened, select path from left panel or from viewport and modify settings of
 
 Export with `File->Export` or `Ctrl+E`
 
-
-## Configuration
+## ✏ Configuration
 
 ![](doc/configuration.png)
 
 Configuration settings are exposed in `Configuration->Settings`, the configuration is splitted in two:
 * general settings aiming dxf importing or default values
 * tools with settings such as radius and gcode formatting
 
-## GCode format
+## 📝 GCode format
 
 Simple set of GCode command is used per tool:
 

doc/configuration.png

@@ -19,8 +19,10 @@
 		<file>icons/list-remove.svg</file>
 		<file>icons/path-inset.svg</file>
 		<file>icons/path-outset.svg</file>
+		<file>icons/pocket-shape.svg</file>
 		<file>icons/resizecol.svg</file>
 		<file>icons/show-path-outline.svg</file>
 		<file>icons/transform-rotate.svg</file>
+		<file>icons/zoom-in.svg</file>
     </qresource>
 </RCC> 

doc/logo.png

@@ -5,7 +5,7 @@
 #include <set>
 #include <memory>
 
-namespace Common
+namespace common
 {
 
 template <class Item>
@@ -16,6 +16,7 @@ class Aggregable
 
 	using List = std::vector<Item>;
 	using ListPtr = std::vector<Item *>;
+	using ListCPtr = std::vector<const Item *>;
 	using ListUPtr = std::vector<UPtr>;
 
 	template <size_t Size>

doc/pocket.gif

@@ -3,7 +3,7 @@
 #include <sstream>
 #include <string>
 
-namespace Common
+namespace common
 {
 
 class FileCouldNotOpenException : public std::exception
@@ -14,7 +14,7 @@ class GCodeFormatException : public std::runtime_error
 {
 private:
 	template <class ... Args>
-	std::string errorMessage(const std::string &format, const char *error, Args&& ... args)
+	static std::string errorMessage(const std::string &format, const char *error, Args&& ... args)
 	{
 		std::ostringstream stream;
 		stream << "Formatting error, format \"" << format << "\" with arguments";