genotrance / nimnuklear Goto Github PK

Nimnuklear is a Nim wrapper for the nuklear library.

Nimnuklear is distributed as a Nimble package and depends on nimgen and c2nim to generate the wrappers. The nuklear source code is downloaded using Git so having git in the path is required.

Installation

Nimnuklear can be installed via Nimble:

> nimble install https://github.com/genotrance/nimnuklear

This will download, wrap and install nimnuklear in the standard Nimble package location, typically ~/.nimble. Once installed, it can be imported into any Nim program.

Usage

Module documentation can be found here.

Refer to the demo directory for examples on how the library can be used.

Credits

Nimnuklear wraps the nuklear source code and all licensing terms of nuklear apply to the usage of this package.

Credits go out to c2nim as well without which this package would be greatly limited in its abilities.

Feedback

Nimnuklear is a work in progress and any feedback or suggestions are welcome. It is hosted on GitHub with an MIT license so issues, forks and PRs are most appreciated.