summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPietro Gagliardi <[email protected]>2014-06-03 23:14:00 -0400
committerPietro Gagliardi <[email protected]>2014-06-03 23:14:12 -0400
commitbc34836227187550b7da8ee0c8a1a91bba8f0466 (patch)
tree99ed642872344437344b4aada6e7251b4db54a25
parent427a0f3a74a1feed3cfbef8894719221e4f8f27b (diff)
Marked the README as needing updates and added API change warnings.
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index ff36289..da3807e 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
[![Build Status](https://travis-ci.org/andlabs/ui.png?branch=master)](https://travis-ci.org/andlabs/ui)
# Native UI library for Go
+### THIS README NEEDS REWRITING. Cleaning out TODOs causes me to change a bunch of different things at the API. Window.Open() no longer returns an error, and the handled return from AreaHandler.KeyEvent() is gone. While for the most part the API is stable enough, it won't be stable as far as what I have implemented now goes until I get all these TODOs nailed. Bear with me here.
+
### THIS PACKAGE IS UNDER ACTIVE DEVELOPMENT. It can be used; the API is stable enough at this point, but keep in mind there may still be crashes and API changes, as suggestions are always open. If you can help, please do! Run `./test` to build a test binary `test/test` which runs a (mostly) feature-complete UI test. Run `./d32 ./test` to build a 32-bit version (you will need a cgo-enabled 32-bit go environment, and I have only tested this on Mac OS X). For Windows targets, you will need a cgo-enabled windows/386 *AND* windows/amd64 to regenerate the autogenerated zconstants_windows_*.go files (cross-compiling multiple cgo-enabled targets in Go isn't possible yet; [I have a CL pending that will make it so](https://codereview.appspot.com/93580043) (it's too late for Go 1.3 but it might land in 1.4; you can try applying it yourself but; I also don't intend on adding a flag to suppress regeneration lest I get complacent and start using it myself and introduce some mystery bug); native Windows targets should be able to work fine, but I haven't tested it).
### UPDATE 12 March 2014: Windows 2000 is no longer supported [as it is no longer supported by Go](https://codereview.appspot.com/74790043).