Skip to content

Commit 35d7f4b

Browse files
authored
Update README.md
1 parent 2429f53 commit 35d7f4b

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ Options:
2323
--help Show this message and exit.
2424
```
2525

26+
# Goals
27+
The goal of this project is to allow all hobbyists needing gcode writing to have everything they need to create the gcode their projects requires. The secondary goal is to get this project basically wholesale assumed into vpype proper. The writer is so open and modular that it can write everything from svg to json to gcode, the hope was to get this sort of thing added to vpype.
28+
29+
# Philosophy
30+
Breaking changes are fine. Anything that will make this code more likely to end up in vpype properly and this particular library getting deprecated will be highly likley to be done.
31+
2632
# Profiles
2733
This plugin supports different output profiles which configure the way the resulting output is formatted. Output profiles are flexible in a way that they can also be used to generate non gcode files, i.e. JSON or CSV files.
2834

@@ -273,3 +279,6 @@ Using this profile, you can generate JSON for the rectangle:
273279
Which is valid JSON.
274280

275281

282+
# Thanks
283+
* abey76 - Helped with advice that largely pushes us towards the integration goals as well as his very solid suggestion to use .format() which greatly expands the expected formats.
284+
* theomega - Basically rewrote the thing into the dapper codebase you see today. Rather than the 4 hours I figured I'd kill on this.

0 commit comments

Comments
 (0)