nimui/README.md
Ganesh Viswanathan 325ef7a8d4 Initial version
2018-08-19 17:52:04 -05:00

1.4 KiB

Nimui is a Nim wrapper for the libui library.

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

Installation

Nimui is currently a work in progress. It can be installed via Nimble:

> nimble install nimgen

> git clone https://github.com/genotrance/nimui
> cd nimui
> nimble install -y

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

Usage

TBD

import nimui/ui

var opts: UiInitOptions
if uiInit(addr opts) != nil:
  quit(1)

Credits

Nimui wraps the libui library and all its licensing terms 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

Nimui 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.