Document different gcode data block encoding format in specification
Nobody has claimed this yet.
- Dominant language
- G-code
- Stars
- 73
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Description
Right now the G-Code data block just lists the encoding header format and lists the possible values for the header field:
0 = No encoding
1 = MeatPack algorithm
2 = MeatPack algorithm modified to keep comment lines
without defining what MeatPack or the modified MeatPack algorithms are. It would be good if the definition of those encoding types were documented (also assuming no encoding just means the text gcode). While you can look at the source code, documenting the actual specifics of the encoding formats will make the specification more useful for people trying to interoperate with the format.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing G-Code data block specification and the source code that implements the MeatPack and modified MeatPack encodings. Document the meaning of encoding values 0, 1, and 2, including whether value 0 is plain text G-code, so readers can interoperate with the format.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100