Elara6331
/
itd
4
6
Fork 11
Code Issues 8 Pull Requests 1 Projects Releases 11 Wiki Activity

Improve itgui compilation documentation (Fixes #24)

This commit is contained in:
Elara 2022-08-29 13:28:52 -07:00
parent 645541e079
commit 5e66fe82ac
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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)