View Source README
TERMBOX2-NIF
An erlang wrapper for the termbox2 library.
Explore the docs »
View Demo·
Report Bug·
Request Feature
Table of Contents
About The Project
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.
Built With
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:
- Clone this repo.
git clone https://github.com/wmealing/termbox2-nif.git
- Build the library
make
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
Roadmap
- [x] Erlang NIF created.
- [ ] Gleam wrapper created.
- [ ] Elixir wrapper
See the open issues for a full list of proposed features (and known issues).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Wade Mealing - wmealing@gmail.com
Garlic0x1 - https://github.com/garlic0x1
Project Link: https://github.com/wmealing/termbox2-nif
Acknowledgments
Used with permission from the garlic0x1 original author. Published to hex.pm with permission.