[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
![crates.io][crates-io-shield]
Table of Contents
-
About The Project
-
Getting Started
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgments
## About The Project
(back to top)
### Built With
(back to top)
## Getting Started
### Prerequisites
* the lates stable version of rust
### Installation
add almond to your Cargo.toml you'll probably want to enable the ```macros``` feature aswell.
(back to top)
## Usage
(back to top)
## Roadmap
See the [open issues](https://github.com/zimlit/almond/issues) for a full list of proposed features (and known issues).
(back to top)
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
(back to top)
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
(back to top)
## Contact
Devin Rockwell - zimlit2010@gmail.com.com
Project Link: [https://github.com/zimlit/almond](https://github.com/zimlit/almond)
(back to top)
(back to top)
[contributors-shield]: https://img.shields.io/github/contributors/zimlit/almond.svg?style=for-the-badge
[contributors-url]: https://github.com/zimlit/almond/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/zimlit/almond.svg?style=for-the-badge
[forks-url]: https://github.com/zimlit/almond/network/members
[stars-shield]: https://img.shields.io/github/stars/zimlit/almond.svg?style=for-the-badge
[stars-url]: https://github.com/zimlit/almond/stargazers
[issues-shield]: https://img.shields.io/github/issues/zimlit/almond.svg?style=for-the-badge
[issues-url]: https://github.com/zimlit/almond/issues
[license-shield]: https://img.shields.io/github/license/zimlit/almond.svg?style=for-the-badge
[license-url]: https://github.com/zimlit/almond/blob/master/LICENSE
[crates-io-shield]: https://img.shields.io/crates/v/almond_engine.svg?style=for-the-badge