diff --git a/README.md b/README.md index fb0dfb82b..3c35a871c 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,25 @@ # Go support for Mobile devices -The Go mobile repository holds packages and build tools for using Go on Android. +The Go mobile repository holds packages and build tools for using Go on mobile platforms. -This is early work and installing the build system requires Go 1.5. -Follow the build instructions on -[godoc.org/golang.org/x/mobile/cmd/gomobile](http://godoc.org/golang.org/x/mobile/cmd/gomobile) -to install the gomobile command and -[build the basic example](http://godoc.org/golang.org/x/mobile/example/basic). +Package documentation serves as a starting point: ---- +- [Building all-Go apps](https://golang.org/x/mobile/app) +- [Building libraries for SDK apps](https://golang.org/x/mobile/cmd/gobind) -APIs are currently very limited, but under active development. Package -documentation serves as a starting point: +![Caution image](doc/caution.png) -- [mobile/app](http://godoc.org/golang.org/x/mobile/app) -- [mobile/gl](http://godoc.org/golang.org/x/mobile/gl) -- [mobile/cmd/gomobile](http://godoc.org/golang.org/x/mobile/cmd/gomobile) -- [mobile/cmd/gobind](http://godoc.org/golang.org/x/mobile/cmd/gobind) +The Go Mobile project is experimental. Use this at your own risk. +While we are working hard to improve it, neither Google nor the Go +team can provide end-user support. ---- +This is early work and installing the build system requires Go 1.5. +Follow the build instructions on +[godoc.org/golang.org/x/mobile/cmd/gomobile](https://golang.org/x/mobile/cmd/gomobile) +to install the gomobile command and +[build the basic example](https://golang.org/x/mobile/example/basic). -- [mobile/exp/audio](http://godoc.org/golang.org/x/mobile/exp/audio) -- [mobile/exp/sensor](http://godoc.org/golang.org/x/mobile/exp/sensor) -- [mobile/exp/sprite](http://godoc.org/golang.org/x/mobile/exp/sprite) +-- Contributions to Go are appreciated. See https://golang.org/doc/contribute.html. diff --git a/doc/caution.png b/doc/caution.png new file mode 100644 index 000000000..cdb9faa93 Binary files /dev/null and b/doc/caution.png differ