44 lines
2.0 KiB
Markdown
44 lines
2.0 KiB
Markdown
# ui: platform-native GUI library for Go
|
|
|
|
# This package is still very much WIP.
|
|
|
|
**Note: Due to [a bug in Go](https://github.com/golang/go/issues/13720) the OS X build is broken. Sorry about that.**
|
|
|
|
As of December 2015 the previous package ui API that has been around since this repo was started is no longer being supported. It is being replaced with a much more stable API built around my libui; see below.
|
|
|
|
If you still want to use the old package ui, you can get the package under the `pre-libui` tag. Keep in mind that it's not stable, buggy, and **no longer supported**. If you do continue, make sure that instances of `ui.Window` escape to the heap to avoid some of the issues.
|
|
|
|
If you want to play around with this new package ui, you'll need to install libui manually. Clone that repo and `make` (with GNU make) libui, then:
|
|
|
|
- On Windows, merely copy out\libui.dll to the root of this repo.
|
|
- On OS X, copy out/libui.dylib to the root of this repo as libui.0.dylib and symlink it to libui.dylib
|
|
- On other Unixes, copy out/libui.so to the root of this repo as libui.so.0 and symlink it to libui.so
|
|
|
|
and then copy ui.h to the top of this repo as well. (You may symlink any files instead of copying if so choose.)
|
|
|
|
Stable releases of package ui will have all these files built in; these steps are only necessary for master builds.
|
|
|
|
# New README
|
|
|
|
This is a library that aims to provide simple GUI software development in Go.
|
|
|
|
It is based on my [libui](https://github.com/andlabs/libui), a simple cross-platform library that does the same thing, but written in C. **You must include this library in your binary distributions.**
|
|
|
|
It runs on/requires:
|
|
|
|
- Windows: cgo, Windows Vista and newer
|
|
- Mac OS X: cgo, Mac OS X 10.7 and newer
|
|
- other Unixes: cgo, GTK+ 3.4 and newer
|
|
|
|
It also requires Go 1.5 or newer (due to various bugs in cgo that were fixed only starting with 1.5).
|
|
|
|
(this README needs some work)
|
|
|
|
# Installation
|
|
|
|
# Documentation
|
|
|
|
The in-code documentation needs improvement. I have written a [tutorial](https://github.com/andlabs/ui/wiki/Getting-Started) in the Wiki.
|
|
|
|
# Updates
|