Skip to main content

README.md

# G-code

[![Hex.pm](https://img.shields.io/hexpm/v/gcode.svg)](https://hex.pm/packages/gcode)
[![Apache-2.0 License](https://img.shields.io/hexpm/l/gcode.svg)](https://www.apache.org/licenses/LICENSE-2.0)

`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

Gcode is [available in Hex](https://hex.pm/packages/gcode), the package can be
installed by adding `gcode` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:gcode, "~> 1.0.2"}
  ]
end
```

Documentation for the latest release can be found on
[HexDocs](https://hexdocs.pm/gcode).

## Github Mirror

This repository is mirrored [on Github](https://github.com/jimsynz/gcode)
from it's primary location [on my Forgejo instance](https://harton.dev/james/gcode).
Feel free to raise issues and open PRs on Github.

## License

This software is licensed under the terms of the
[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0), see the `LICENSE.md`
file included with this package for the terms.