Chickenwire

A library for representing and manipulating hexagonal grids in Rust.

Contents

1. Installation
2. Usage
3. Documentation
4. Contributing
5. Credits
6. License

Installation

Add the following to your project's Cargo.toml file under [dependencies]:

chickenwire = "0.1.0"

Check out Chickenwire's Cargo page for the latest version info.

Usage

[Documentation needed]

Documentation

• API docs
• Changelog

Contributing

Please read the following:

• Chickenwire style guide
• Chickenwire contribution guide

before filing issues and/or making contributions.

Credits

Dependencies

• Bheisler's criterion.rs
• Bluss' petgraph

Design

• Red Blob Games' article on hexagonal grids

License

Dual-licensed to be compatible with the Rust project.

This software and associated documentation files are licensed under one of the following:

• Apache License, Version 2.0
• MIT License

at your option. This file may not be copied, modified, or distributed except according to those terms.