mirror of
https://git.sr.ht/~eliasnaur/gio
synced 2026-07-02 16:06:19 +00:00
Elias Naur
063b4a5659
Some platforms run on previous Go versions, but let's nudge people to use Go 1.13. Go 1.13 is required to build for WebAssembly and for running Go binaries on the latest versions of Android, iOS, tvOS. Signed-off-by: Elias Naur <mail@eliasnaur.com>
141 lines
5.0 KiB
Markdown
141 lines
5.0 KiB
Markdown
# Gio
|
|
|
|
Gio implements portable immediate mode GUI programs in Go. Gio programs run on all the major platforms:
|
|
iOS/tvOS, Android, Linux (Wayland), macOS, Windows and browsers (Webassembly/WebGL).
|
|
|
|
Gio includes an efficient vector renderer based on the Pathfinder project (https://github.com/pcwalton/pathfinder).
|
|
Text and other shapes are rendered using only their outlines without baking them into texture images,
|
|
to support efficient animations, transformed drawing and pixel resolution independence.
|
|
|
|
[](https://godoc.org/gioui.org/ui)
|
|
|
|
|
|
## Installation
|
|
|
|
Gio is designed to work with very few dependencies. It depends only on the platform libraries for
|
|
window management, input and GPU drawing.
|
|
|
|
- [Linux](https://man.sr.ht/~eliasnaur/gio/install.md#linux)
|
|
- [macOS, iOS, tvOS](https://man.sr.ht/~eliasnaur/gio/install.md#macos-ios-tvos)
|
|
- [Windows](https://man.sr.ht/~eliasnaur/gio/install.md#windows)
|
|
- [Android](https://man.sr.ht/~eliasnaur/gio/install.md#android)
|
|
- [WebAssembly](https://man.sr.ht/~eliasnaur/gio/install.md#webassemblywebgl)
|
|
|
|
|
|
## Running Gio programs
|
|
|
|
With [Go 1.13](https://golang.org/dl/) or newer,
|
|
|
|
$ export GO111MODULE=on
|
|
$ go run gioui.org/apps/hello
|
|
|
|
should display a simple message in a window.
|
|
|
|
The command
|
|
|
|
$ go run gioui.org/apps/gophers
|
|
|
|
runs a simple (nonsense) demo that displays Go contributors fetched from GitHub.
|
|
|
|
If you run into quota issues, supply a
|
|
[Github token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)
|
|
with the `-token` flag:
|
|
|
|
$ go run gioui.org/apps/gophers -token <github token>
|
|
|
|
|
|
## Running on mobiles
|
|
|
|
For Android, iOS, tvOS the `gio` tool can build and package a Gio program for you.
|
|
|
|
To build an Android .apk file from the `gophers` example:
|
|
|
|
$ go run gioui.org/cmd/gio -target android gioui.org/apps/gophers
|
|
|
|
The apk can be installed to a running emulator or attached device with adb:
|
|
|
|
$ adb install gophers.apk
|
|
|
|
The gio tool passes command line arguments to os.Args at runtime:
|
|
|
|
$ go run gioui.org/cmd/gio -target android gioui.org/apps/gophers -token <github token>
|
|
|
|
The `-appid` flag specifies the iOS bundle id or Android package id. The flag is required
|
|
for creating signed .ipa files for iOS and tvOS devices, because the bundle id must match an id
|
|
previously provisioned in Xcode. For example,
|
|
|
|
$ go run gioui.org/cmd/gio -target ios -appid <bundle-id> gioui.org/apps/gophers
|
|
|
|
Use the `Window->Devices and Simulators` option in Xcode to install the ipa file to the device.
|
|
If you have [ideviceinstaller](https://github.com/libimobiledevice/ideviceinstaller) installed,
|
|
you can install the app from the command line:
|
|
|
|
$ ideviceinstaller -i gophers.ipa
|
|
|
|
If you just want to run a program on the iOS simulator, use the `-o` flag to specify a .app
|
|
directory:
|
|
|
|
$ go run gioui.org/cmd/gio/ -o gophers.app -target ios gioui.org/apps/gophers
|
|
|
|
Install the app to a running simulator with simctl:
|
|
|
|
$ xcrun simctl install booted gophers.app
|
|
|
|
|
|
## Webassembly/WebGL
|
|
|
|
To run a Gio program in a compatible browser, the `gio` tool can output a directory ready to
|
|
serve. With the `goxec` tool you don't even need a web server:
|
|
|
|
$ go run gioui.org/cmd/gio -target js gioui.org/apps/gophers
|
|
$ go get github.com/shurcooL/goexec
|
|
$ goexec 'http.ListenAndServe(":8080", http.FileServer(http.Dir("gophers")))'
|
|
|
|
Open http://localhost:8080 in a browser to run the program.
|
|
|
|
|
|
## Integration with existing projects
|
|
|
|
See the [integration guide](https://man.sr.ht/~eliasnaur/gio/integrate.md) for details on using
|
|
Gio with existing projects.
|
|
|
|
|
|
## Programs using Gio
|
|
|
|
- [Scatter](https://scatter.im), an implementation of the Signal protocol over email.
|
|
|
|
|
|
## Resources
|
|
|
|
- [FAQ](https://man.sr.ht/~eliasnaur/gio/faq.md).
|
|
- [Gophercon 2019 talk](https://www.youtube.com/watch?v=9D6eWP4peYM) about Gio and [Scatter](https://scatter.im).
|
|
[Slides](https://go-talks.appspot.com/github.com/eliasnaur/gophercon-2019-talk/gophercon-2019.slide),
|
|
[Demos](https://github.com/eliasnaur/gophercon-2019-talk).
|
|
- [Gophercon UK 2019 talk](https://go-talks.appspot.com/github.com/eliasnaur/gophercon-uk-2019-talk/gophercon-uk-2019-live.slide).
|
|
[Demos](https://github.com/eliasnaur/gophercon-uk-2019-talk).
|
|
|
|
|
|
## Issues
|
|
|
|
File bugs and TODOs through the [issue tracker](https://todo.sr.ht/~eliasnaur/gio) or send an email
|
|
to [~eliasnaur/gio@todo.sr.ht](mailto:~eliasnaur/gio@todo.sr.ht). For general discussion, use the
|
|
mailing list: [~eliasnaur/gio@lists.sr.ht](mailto:~eliasnaur/gio@lists.sr.ht).
|
|
|
|
|
|
## Contributing
|
|
|
|
Post discussion and patches to the [mailing list](https://lists.sr.ht/~eliasnaur/gio). No Sourcehut
|
|
account is required and you can post without being subscribed.
|
|
|
|
See the [contribution guide](https://man.sr.ht/~eliasnaur/gio/contribute.md) for more details.
|
|
|
|
|
|
## License
|
|
|
|
Dual-licensed under [UNLICENSE](http://unlicense.org) or the MIT.
|
|
|
|
## Donations
|
|
|
|
Bitcoin donations are gladly accepted to [bc1q8xw95urett00f4xs3v66p2l6xp2mfk5erpe5ug](bitcoin:bc1q8xw95urett00f4xs3v66p2l6xp2mfk5erpe5ug).
|
|
Donations will go toward hosting expenses and for supporting the author's full time work on Gio.
|