From 5e66fe82ac6fefc1edc6c3c724a8b3b28d37fd2a Mon Sep 17 00:00:00 2001 From: Arsen Musayelyan Date: Mon, 29 Aug 2022 13:28:52 -0700 Subject: [PATCH] Improve itgui compilation documentation (Fixes #24) --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5365284..fe1f729 100644 --- a/README.md +++ b/README.md @@ -105,12 +105,22 @@ Use "itctl [command] --help" for more information about a command. ### `itgui` -In `cmd/itgui`, there is a gui frontend to the socket of `itd`. It uses the [fyne library](https://fyne.io/) for Go. It can be compiled by running: +In `cmd/itgui`, there is a gui frontend to the socket of `itd`. It uses the [Fyne library](https://fyne.io/) for Go. + +#### Compilation + +Before compiling, certain prerequisites must be installed. These are listed on the following page: https://developer.fyne.io/started/#prerequisites + +It can be compiled by running: ```shell go build ./cmd/itgui ``` +#### Cross-compilation + +Due to the use of OpenGL, cross-compilation of `itgui` isn't as simple as that of `itd` and `itctl`. The following guide from the Fyne website should work for `itgui`: https://developer.fyne.io/started/cross-compiling. + #### Screenshots ![Info tab](cmd/itgui/screenshots/info.png)