evan/zenity
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Nuno Cruces 2022-06-23 15:19:00 +01:00 committed by GitHub
parent a52a097be2
commit c1b80b310e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -5,10 +5,11 @@
[![Go Cover](https://gocover.io/_badge/github.com/ncruces/zenity)](https://gocover.io/github.com/ncruces/zenity) [![Go Cover](https://gocover.io/_badge/github.com/ncruces/zenity)](https://gocover.io/github.com/ncruces/zenity)
[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go) [![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)
This repo includes both a cross-platform Go package providing This repo includes:
- a cross-platform [Go](https://go.dev/) package providing
[Zenity](https://help.gnome.org/users/zenity/stable/)-like dialogs [Zenity](https://help.gnome.org/users/zenity/stable/)-like dialogs
(simple dialogs that interact graphically with the user), (simple dialogs that interact graphically with the user)
as well as a *“port”* of the `zenity` command to both Windows and macOS based on that library. - a *“port”* of the `zenity` command to both Windows and macOS based on that library.
Implemented dialogs: Implemented dialogs:
* [message](https://github.com/ncruces/zenity/wiki/Message-dialog) (error, info, question, warning) * [message](https://github.com/ncruces/zenity/wiki/Message-dialog) (error, info, question, warning)
@ -39,18 +40,24 @@ The `zenity` command on Windows using [Scoop](https://scoop.sh/) 🍨:
scoop install https://ncruces.github.io/scoop/zenity.json scoop install https://ncruces.github.io/scoop/zenity.json
The `zenity` command on macOS/Windows if you have Go: The `zenity` command on macOS/Windows, if you have [Go](https://go.dev/):
go install github.com/ncruces/zenity/cmd/zenity@latest go install github.com/ncruces/zenity/cmd/zenity@latest
Or download the [latest release](https://github.com/ncruces/zenity/releases/latest). Or download the [latest release](https://github.com/ncruces/zenity/releases/latest).
## Using
For the Go package, consult the [documentation](https://pkg.go.dev/github.com/ncruces/zenity#section-documentation)
and [examples](https://pkg.go.dev/github.com/ncruces/zenity#pkg-examples).
The `zenity` command does its best to be compatible with the GNOME version.\
Consult the [documentation](https://help.gnome.org/users/zenity/stable/)
and [man page](https://linux.die.net/man/1/zenity) of that command.
## Why? ## Why?
There are a bunch of other dialog packages for Go.\ #### Benefits of the Go package:
Why reinvent this particular wheel?
#### Benefits:
* no `cgo` (see [benefits](https://dave.cheney.net/2016/01/18/cgo-is-not-go), mostly cross-compilation) * no `cgo` (see [benefits](https://dave.cheney.net/2016/01/18/cgo-is-not-go), mostly cross-compilation)
* no main loop (or any other threading or initialization requirements) * no main loop (or any other threading or initialization requirements)