<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]
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/wmealing/termbox2-nif">
<img src="images/logo.svg" alt="Logo" width="80" height="80">
</a>
<h3 align="center">TERMBOX2-NIF</h3>
<p align="center">
An erlang wrapper for the termbox2 library.
<br />
<a href="https://github.com/wmealing/termbox2-nif"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/wmealing/termbox2-nif">View Demo</a>
·
<a href="https://github.com/wmealing/termbox2-nif/issues/new?labels=bug">Report Bug</a>
·
<a href="https://github.com/wmealing/termbox2-nif/issues/new?labels=enhancement&template=feature-request---.md">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)
Ever wanted to write a TUI library based on termbox2 in beam based languages ?
Tired of writing web apps that may make your app popular and usable by many while likely wasting near gigabytes of memory ?
You could write a TUI, using this library to avoid the pitfalls.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Built With
* [![Erlang][Erlang]][Erlang-url]
* [![Termbox][Termbox2]][Termbox2-url]
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
### Prerequisites
You will need to have a
* modern erlang (Version 22+)
* make
* c compiler.
### Installation
TBD: Should we get this from hex.pm show how to use it as a dep ?
Manually:
1. Clone this repo.
```sh
git clone https://github.com/wmealing/termbox2-nif.git
```
2. Build the library
```sh
make
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- USAGE EXAMPLES -->
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
_For more examples, please refer to the [Documentation](https://example.com)_
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ROADMAP -->
## Roadmap
- [x] Erlang NIF created.
- [ ] Gleam wrapper created.
- [ ] Elixir wrapper
See the [open issues](https://github.com/wmealing/termbox2-nif/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
- Wade Mealing - wmealing@gmail.com
- Garlic0x1 - https://github.com/garlic0x1
Project Link: [https://github.com/wmealing/termbox2-nif](https://github.com/wmealing/termbox2-nif)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
Used with permission from the garlic0x1 original author. Published to hex.pm with permission.
<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/wmealing/termbox2-nif.svg?style=for-the-badge
[contributors-url]: https://github.com/wmealing/termbox2-nif/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/wmealing/termbox2-nif.svg?style=for-the-badge
[forks-url]: https://github.com/wmealing/termbox2-nif/network/members
[stars-shield]: https://img.shields.io/github/stars/wmealing/termbox2-nif.svg?style=for-the-badge
[stars-url]: https://github.com/wmealing/termbox2-nif/stargazers
[issues-shield]: https://img.shields.io/github/issues/wmealing/termbox2-nif.svg?style=for-the-badge
[issues-url]: https://github.com/wmealing/termbox2-nif/issues
[license-shield]: https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge
[license-url]: https://github.com/wmealing/termbox2-nif/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/linkedin_username
[product-screenshot]: images/screenshot.png
[Erlang]: https://img.shields.io/badge/erlang-000000?style=for-the-badge&logo=erlang&logoColor=white
[Erlang-url]: https://www.erlang.org/
[Termbox2]: https://img.shields.io/badge/termbox2-000000?style=for-the-badge&logo=codewars&logoColor=61DAFB
[Termbox2-url]: https://github.com/termbox/termbox2
[React-url]: https://reactjs.org/
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
[Vue-url]: https://vuejs.org/
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com
