version bump and readme updates

rmeno12 · Jan 14, 2022 · 17e166a · 17e166a
1 parent 7fc93ec
commit 17e166a
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,15 @@ $ pip3 install gcodepy
 ```
 Note that `gcodepy` has only been tested with Python 3.X and no guarantees are made about compatibility with the deprecated Python 2.X.
 
+## Examples
+One of the most interesting things to do with `gcodepy` is to do toolhead movements using mathematical functions.
+For example, you can make your printer go in a spiral:
+![zspiral image](imgs/zspiral.png)
+This example is defined in `examples/zspiral.py`.
+For more examples, check the `examples` folder.
+
 ## Planned features
-- cleaner interfacing for absolute movements
-- more examples
+- cleaner gcode output (particularly feedrates)
+- better interfacing for absolute movements
+- better detection + handling of invalid inputs/movements
 
diff --git a/imgs/zspiral.png b/imgs/zspiral.png
diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = gcodepy
-version = 0.1.0
+version = 0.1.1
 author = Rahul Menon
 author_email = [email protected]
 description = Tool to generate g-code for Marlin based printers

diff --git a/src/gcodepy/gcode.py b/src/gcodepy/gcode.py
@@ -5,6 +5,7 @@
 # TODO:
 # minimize feedrate output
 # draw absolute
+# travel func
 # catch more invalid inputs
 class Gcode:
     def __init__(