ref: 3099e7474f59db7d42f1a9d1c461477c4f6ff31b gio/README.md -rw-r--r-- 4.5 KiB View raw
3099e747Elias Naur README.md: fix link 10 months ago


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.


Gio is designed to work with very few dependencies. It depends only on the platform libraries for window management, input and GPU drawing.

Running Gio programs

With Go 1.12 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 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 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


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 for details on using Gio with existing projects.

Programs using Gio

  • Scatter, an implementation of the Signal protocol over email.



File bugs and TODOs through the the issue tracker or send an email to ~eliasnaur/gio@todo.sr.ht. For general discussion, use the mailing list: ~eliasnaur/gio@lists.sr.ht.


Post discussion and patches to the mailing list. No Sourcehut account is required and you can post without being subscribed.

See the contribution guide for more details.


Dual-licensed under UNLICENSE or the MIT.