gcode/README.md

22 lines
969 B
Markdown
Raw Normal View History

2021-01-05 09:16:52 +13:00
# G-code
2021-01-02 18:24:55 +13:00
2021-01-05 09:16:52 +13:00
`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.
2021-01-02 18:24:55 +13:00
## Installation
2021-01-10 18:44:04 +13:00
This package is [available in Hex](https://hex.pm/packages/gcode).
2021-01-02 18:24:55 +13:00
2021-01-13 13:29:59 +13:00
You can install it from git by adding `{:gcode, "~> 0.4.1"}` to your dependencies.
2021-01-02 18:24:55 +13:00
2021-01-05 09:16:52 +13:00
## Documentation
2021-01-02 18:24:55 +13:00
2021-01-10 18:44:04 +13:00
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).
2021-01-05 09:16:52 +13:00
## Contributing
2021-01-10 18:44:04 +13:00
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.
2021-01-05 09:16:52 +13:00
## License
This library is licensed with the [Hippocratic License 2.1](https://firstdonoharm.dev/version/2/1/license.html).