+ Support of splines

+ SVG Autosize + Sample image ! Fixed bugs with loops ! Replaced Sphinx Doc with single MD
AndreyZarembo · Mar 8, 2023 · 92b3b3d · 92b3b3d
1 parent c09f444
commit 92b3b3d
Show file tree

Hide file tree

Showing 29 changed files with 35,239 additions and 288 deletions.
diff --git a/.gitignore b/.gitignore
@@ -127,3 +127,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+.idea
diff --git a/Readme.rst → README.md b/Readme.rst → README.md
@@ -3,27 +3,25 @@ Laser Offset
 
 Simple Tools that creates external and internal offsets for shapes. Supports DXF and SVG Import/Export.
 
-.. note::
-
     This project is in early alpha and was created as side-project for hobby.
-    
-It has `Limitations`_
+
+![](imgs/outlines.svg)
 
 Installing
 ----------
 
 Install and update using `pip`_:
 
-.. code-block:: text
+```
 
     $ pip install -U laser_offset
 
-.. _pip: https://pip.pypa.io/en/stable/getting-started/
+```
 
 Usage
 -----
 
-.. code-block:: text
+```
 
     Usage: laser_offset [OPTIONS] SOURCE_PATH TARGET_PATH LASER_WIDTH
 
@@ -41,9 +39,14 @@ Usage
     -d, --dxf / -D, --no-dxf  Output as DXF  [default: (True)]
     --help                    Show this message and exit.
 
+```
+
+**Example:**
+
+`laser_offset . ./output -s 150`
+
 Limitations
 -----------
 
-1. Not working with splines. Only circles and paths. And can merge lines and arcs into path if they has connected ends
-2. Can't handle arcs less that half of laser width
-3. Ignores layers, shape size and styles
+1. Can't handle arcs less that half of laser width
+2. Ignores layers, text, shape size and styles
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/source/conf.py b/docs/source/conf.py
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/imgs/outlines.svg b/imgs/outlines.svg
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "laser_offset"
-version = "0.1.0"
+version = "0.5.0"
 authors = [
   { name="Andrey Zarembo-Godzyatskiy", email="[email protected]" },
 ]
Original file line number	Diff line number	Diff line change
Expand Up		@@ -127,3 +127,4 @@ dmypy.json

		# Pyre type checker
		.pyre/
		.idea