wmealing/termbox2-nif

Erlang NIF for termbox2

TERMBOX2-NIF

An erlang wrapper for the termbox2 library.
Explore the docs »
View Demo· Report Bug· Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

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.

(back to top)

Built With

• 
• 

(back to top)

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.

   git clone https://github.com/wmealing/termbox2-nif.git

2. Build the library

    make

(back to top)

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

(back to top)

Roadmap

• Erlang NIF created.
• Gleam wrapper created.
• Elixir wrapper

See the open 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 for more information.

(back to top)

Contact

• Wade Mealing - wmealing@gmail.com

• Garlic0x1 - https://github.com/garlic0x1

Project Link: https://github.com/wmealing/termbox2-nif

(back to top)

Acknowledgments

Used with permission from the garlic0x1 original author. Published to hex.pm with permission.

(back to top)