# tcod_window
Linux / OS X travis-badge
Windows appveyor-badge
api-docs-badge crates-io license-badge coveralls-badge
A TCOD back-end for the Piston game engine. # Table of Contents * [Usage](#usage) * [Contributing](#contributing) * [Credits](#credits) * [License](#license) ## Usage Add the following to your `Cargo.toml`: ```toml [dependencies] tcod_window = "0.2" ``` And in your `lib.rs` or `main.rs`: ```rust extern crate tcod_window; ``` See the [API docs][api-docs] for information on using the crate in your library. For usage examples, please the see the [examples][examples] directory of the project. ## Contributing Contributions are always welcome! If you have an idea for something to add (code, documentation, tests, examples, etc.) feel free to give it a shot. Please read [CONTRIBUTING.md][contributing] before you start contributing. ## Credits The list of contributors to this project can be found at [CONTRIBUTORS.md][contributors]. ## License `tcod_window` is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See [LICENSE-APACHE][license-apache], and [LICENSE-MIT][license-mit] for details. [api-docs]: https://indiv0.github.io/tcod_window/tcod_window [contributing]: https://github.com/indiv0/tcod_window/blob/master/CONTRIBUTING.md "Contribution Guide" [contributors]: https://github.com/indiv0/tcod_window/blob/master/CONTRIBUTORS.md "List of Contributors" [examples]: https://github.com/indiv0/tcod_window/tree/master/examples "tcod_window - Examples" [license-apache]: https://github.com/indiv0/tcod_window/blob/master/LICENSE-APACHE "Apache-2.0 License" [license-mit]: https://github.com/indiv0/tcod_window/blob/master/LICENSE-MIT "MIT License"