README.md
[](http://spiceprogram.org/oss-sponsorship)
[](https://travis-ci.org/Cadiac/hextille)
# Hextille
Module for common math operations in hexagonal grids. See [this excellent article](http://www.redblobgames.com/grids/hexagons/) for more.
## Installation
The package can be installed by adding `hextille` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:hextille, "~> 0.1.0"}
]
end
```
## Development
Install dependencies with
```
$ mix deps.get
```
### Testing
To run tests run
```
$ mix test
```
at the root of the project.
### Documentation
Documentation can be generated using [ExDoc](https://github.com/elixir-lang/ex_doc)
and it is published on [https://hexdocs.pm/hextille](https://hexdocs.pm/hextille).
To generate documentation locally, run `mix docs`.