21 lines
969 B
Markdown
21 lines
969 B
Markdown
# G-code
|
|
|
|
`gcode` is an Elixir library for parsing and generating [G-code](https://en.wikipedia.org/wiki/G-code), which is a common language for working with CNC machines and 3D printers.
|
|
|
|
## Installation
|
|
|
|
This package is [available in Hex](https://hex.pm/packages/gcode).
|
|
|
|
You can install it from git by adding `{:gcode, "~> 0.4.0"}` to your dependencies.
|
|
|
|
## Documentation
|
|
|
|
Documentation for the main branch of this package is always available [on gitlab pages](https://jimsy.gitlab.io/gcode), and released versions are published [on Hexdocs](https://hexdocs.pm/gcode).
|
|
|
|
## Contributing
|
|
|
|
This project uses the wonderful [git_ops](https://hex.pm/packages/git_ops) package to automate releases and as such requires the use of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Feel free to open issues and pull requests.
|
|
|
|
## License
|
|
|
|
This library is licensed with the [Hippocratic License 2.1](https://firstdonoharm.dev/version/2/1/license.html).
|