andlabs-ui/README.md

# 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
Added a new README. 2014-08-30 22:05:36 -05:00			`# ui: platform-native GUI library for Go`

Updated build and rewrite instructions. This was the wrong time to start rewriting this package... 2015-12-16 08:57:12 -06:00			`# This package is still very much WIP.`

Readme fix. Issue linking only works on issues, apparently. 2015-12-31 23:22:59 -06:00			`Note: Due to [a bug in Go](https://github.com/golang/go/issues/13720) the OS X build is broken. Sorry about that.`
Marked the OS X version as unusable. 2015-12-31 23:20:14 -06:00
Updated build and rewrite instructions. This was the wrong time to start rewriting this package... 2015-12-16 08:57:12 -06:00			`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`
fix typo in README 2015-12-21 23:40:12 -06:00			`- On other Unixes, copy out/libui.so to the root of this repo as libui.so.0 and symlink it to libui.so`
Updated build and rewrite instructions. This was the wrong time to start rewriting this package... 2015-12-16 08:57:12 -06:00
			`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`

LET'S GET THIS FINAL REWRITE EVER STARTED 2015-12-11 19:37:59 -06:00			`This is a library that aims to provide simple GUI software development in Go.`
Split the rewrite into a new repository. 2015-04-16 19:33:28 -05:00
LET'S GET THIS FINAL REWRITE EVER STARTED 2015-12-11 19:37:59 -06:00			`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.`
Split the rewrite into a new repository. 2015-04-16 19:33:28 -05:00
LET'S GET THIS FINAL REWRITE EVER STARTED 2015-12-11 19:37:59 -06:00			`It runs on/requires:`
README updates. 2014-09-05 20:38:55 -05:00
LET'S GET THIS FINAL REWRITE EVER STARTED 2015-12-11 19:37:59 -06:00			`- Windows: cgo, Windows Vista and newer`
Re-added the note about MinGW-w64 to the README. It got lost in the rewrite migration. 2014-09-26 20:19:30 -05:00			`- Mac OS X: cgo, Mac OS X 10.7 and newer`
			`- other Unixes: cgo, GTK+ 3.4 and newer`
Added a new README. 2014-08-30 22:05:36 -05:00
Added OS X building. Go 1.5 required because of https://github.com/golang/go/issues/9411 which affects this. Also set up proper multithreading on OS X. Currently crashes due to similar issue I've had with libui. 2015-12-13 01:24:43 -06:00			`It also requires Go 1.5 or newer (due to various bugs in cgo that were fixed only starting with 1.5).`
Added a new README. 2014-08-30 22:05:36 -05:00
			`(this README needs some work)`

LET'S GET THIS FINAL REWRITE EVER STARTED 2015-12-11 19:37:59 -06:00			`# Installation`
Added screenshot. 2014-08-30 22:33:57 -05:00
README updates. 2014-09-24 08:34:13 -05:00			`# Documentation`

Link to tutorial in README.md 2014-10-06 19:45:31 -05:00			`The in-code documentation needs improvement. I have written a [tutorial](https://github.com/andlabs/ui/wiki/Getting-Started) in the Wiki.`
README updates. 2014-09-24 08:34:13 -05:00
Changed Grid to SimpleGrid in preparation for a better Grid. 2014-08-31 12:02:47 -05:00			`# Updates`