macademia 0.5.1

<a name="readme-top"></a>


[![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]][crates-io]
[![docs][docs-rs-shield]][docs-rs]


<!-- PROJECT LOGO -->

<br />
<div align="center">
  <a href="https://github.com/zimlit/macademia">
    <img src="images/logo.png" alt="Logo" width="80" height="80">
  </a>

<h3 align="center">macademia</h3>

  <p align="center">
    A realtime application/game engine written in rust
    <br />
    <a href="https://docs.rs/macademia/latest/macademia/"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/zimlit/macademia">View Demo</a>
    ·
    <a href="https://github.com/zimlit/macademia/issues">Report Bug</a>
    ·
    <a href="https://github.com/zimlit/macademia/issues">Request Feature</a>
  </p>
</div>



<!-- TABLE OF CONTENTS -->

<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ol>
</details>



<!-- ABOUT THE PROJECT -->

## About The Project


<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->


<p align="right">(<a href="#readme-top">back to top</a>)</p>



### Built With



<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- GETTING STARTED -->

## Getting Started



### Prerequisites


* the latest stable version of rust

### Installation


add macademia to your Cargo.toml you'll probably want to enable the ```macros``` feature aswell.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- USAGE EXAMPLES -->

## Usage


<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- ROADMAP -->

## Roadmap


See the [open issues](https://github.com/zimlit/macademia/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- CONTRIBUTING -->

## 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

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- LICENSE -->

## License


Distributed under the MIT License. See `LICENSE.txt` for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- CONTACT -->

## Contact


Devin Rockwell - zimlit2010@gmail.com.com

Project Link: [https://github.com/zimlit/macademia](https://github.com/zimlit/macademia)

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- ACKNOWLEDGMENTS -->

<!-- ## Acknowledgments -->


<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- MARKDOWN LINKS & IMAGES -->

<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/zimlit/macademia.svg?style=for-the-badge
[contributors-url]: https://github.com/zimlit/macademia/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/zimlit/macademia.svg?style=for-the-badge
[forks-url]: https://github.com/zimlit/macademia/network/members
[stars-shield]: https://img.shields.io/github/stars/zimlit/macademia.svg?style=for-the-badge
[stars-url]: https://github.com/zimlit/macademia/stargazers
[issues-shield]: https://img.shields.io/github/issues/zimlit/macademia.svg?style=for-the-badge
[issues-url]: https://github.com/zimlit/macademia/issues
[license-shield]: https://img.shields.io/github/license/zimlit/macademia.svg?style=for-the-badge
[license-url]: https://github.com/zimlit/macademia/blob/master/LICENSE
[crates-io-shield]: https://img.shields.io/crates/v/macademia.svg?style=for-the-badge
[crates-io]: https://crates.io/crates/macademia/
[docs-rs-shield]: https://img.shields.io/docsrs/macademia?style=for-the-badge
[docs-rs]: https://docs.rs/macademia/latest/macademia/