Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/burlingsmith/chickenwire
Hexagonal grids in Rust
https://github.com/burlingsmith/chickenwire
game hexagon hexagonal-grids hexgrid rust
Last synced: 4 days ago
JSON representation
Hexagonal grids in Rust
- Host: GitHub
- URL: https://github.com/burlingsmith/chickenwire
- Owner: burlingsmith
- License: apache-2.0
- Created: 2019-06-05T05:43:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-09-24T10:50:55.000Z (about 5 years ago)
- Last Synced: 2024-09-01T14:02:46.637Z (2 months ago)
- Topics: game, hexagon, hexagonal-grids, hexgrid, rust
- Language: Rust
- Homepage:
- Size: 106 KB
- Stars: 9
- Watchers: 0
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-starred - burlingsmith/chickenwire - Hexagonal grids in Rust (rust)
README
# Chickenwire
A library for representing and manipulating hexagonal grids in Rust.
## Contents
1. [Installation](#installation)
2. [Usage](#usage)
3. [Documentation](#documentation)
4. [Contributing](#contributing)
5. [Credits](#credits)
6. [License](#license)
## Installation
Add the following to your project's `Cargo.toml` file under `[dependencies]`:
```toml
chickenwire = "0.1.0"
```
Check out [Chickenwire's Cargo page](https://crates.io/crates/chickenwire) for
the latest version info.
## Usage
[Documentation needed]
## Documentation
- [API docs](https://docs.rs/chickenwire/0.1.0/)
- [Changelog](CHANGELOG.md)
## Contributing
Please read the following:
- [Chickenwire style guide](style-guide.md)
- [Chickenwire contribution guide](CONTRIBUTING.md)
before filing issues and/or making contributions.
## Credits
**Dependencies**
- [Bheisler's criterion.rs](https://github.com/bheisler/criterion.rs)
- [Bluss' petgraph](https://github.com/bluss/petgraph)
**Design**
- [Red Blob Games' article](https://www.redblobgames.com/grids/hexagons) 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](https://www.apache.org/licenses/LICENSE-2.0)
- [MIT License](https://opensource.org/licenses/MIT)
at your option. This file may not be copied, modified, or distributed except
according to those terms.