interesting
/
andlabs-ui
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md 

Should close #37 and #74
This commit is contained in:
Duckbrain 2016-02-05 05:23:52 -08:00
parent ac85bff62f
commit f18a80cbb7
1 changed files with 19 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,15 +1,32 @@
# ui: platform-native GUI library for Go
# This package is still very much WIP.
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.**
## This package is still very much WIP.
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.
## Documentation
The [in-code documentation](https://godoc.org/github.com/andlabs/ui) needs improvement. I have written a [tutorial](https://github.com/andlabs/ui/wiki/Getting-Started) in the Wiki.
## Requirements
- 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
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.
- Go 1.5 is adequate.
- Use `go build -ldflags="-H windowsgui` to compile so Windows won't open the console window
- On OS X, copy out/libui.A.dylib to the root of this repo as libui.A.dylib and symlink it to libui.dylib
- You must also be running Go 1.6 Beta 2 or newer due to more Go bugs.
- On other Unixes, copy out/libui.so.0 to the root of this repo as libui.so.0 and symlink it to libui.so
@ -19,26 +36,6 @@ and then copy ui.h to the top of this repo as well. (You may symlink any files i
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.6 or newer (due to various bugs in cgo that were fixed only starting with 1.6).
(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
## Updates