Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix readme.md #89

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Values above 0.1 are not recommended, as you may encounter overlapping toolpaths
#### Path Tolerance Percent (length)
This parameter allows you control how much the length of the final arc can deviate from the original toolpath. The default value of 5% is absolutely fine in most cases, even though that sounds like a lot. The key thing to remember here is that your firmware will break the G2/G3 commands into many small segments, essentially reversing the process, so the path length in your firmware will match the original path much more closely.

Originally, this setting was added as a safety feature to prevent prevent bad arcs from being generated in some edge cases. However, since then a new error detection algorithm was added that makes this unnecessary. In some cases, especially if your resolution parameter is large (above 0.1), this setting can be used to fine tune the generated arcs, so I left this setting in as is. 99+% of the time, no adjustments will be necessary here.
Originally, this setting was added as a safety feature to prevent bad arcs from being generated in some edge cases. However, since then a new error detection algorithm was added that makes this unnecessary. In some cases, especially if your resolution parameter is large (above 0.1), this setting can be used to fine tune the generated arcs, so I left this setting in as is. 99+% of the time, no adjustments will be necessary here.

* Type: Value (percent)
* Default: 0.05 (5%)
Expand Down Expand Up @@ -621,4 +621,4 @@ I'm not 100% sure exactly what this does, but I believe it attempts to limit the
* Default: 0.01
* Short Parameter: -e=<decimal_value>
* Long Parameter: --mm-max-arc-error=<decimal_value>
* Example: ```ArcStraightener "C:\thing.aw.gcode" --mm-max-arc-error=0.25```
* Example: ```ArcStraightener "C:\thing.aw.gcode" --mm-max-arc-error=0.25```