From 77f78ba34b59f9b8011cbd7a2ba712a0db8564e8 Mon Sep 17 00:00:00 2001 From: Nuno Cruces Date: Thu, 9 Jan 2020 13:26:58 +0000 Subject: [PATCH] Update README.md --- README.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2dd2ad7..b8be6b4 100644 --- a/README.md +++ b/README.md @@ -1 +1,38 @@ -# Zenity dialogs for Golang, Windows and macOS \ No newline at end of file +# Zenity dialogs for Golang, Windows and macOS + +[![GoDoc](https://godoc.org/github.com/ncruces/zenity?status.svg)](https://godoc.org/github.com/ncruces/zenity) + +This repo includes both a cross-platform Go package providing [Zenity](https://help.gnome.org/users/zenity/)-like dialogs, +as well as a *“port”* of the `zenity` command to both Windows and macOS based on that library. + +**This is a work in progress.** + +Lots of things are missing. +For now, these are the only implemented dialogs: +* message (error, info, question, warning); and +* file selection. + +Behavior on Windows, macOS and other UNIXes might differ sliglty. +Some of that is intended (reflecting platform differences), +other bits are unfortunate limitations, +others still open to be fixed. + +## Why? + +There are a bunch of other dialog packages for Go. +Why reinvent this particular wheel? + +#### Requirements: + +* no `cgo` (see [benefits](https://dave.cheney.net/2016/01/18/cgo-is-not-go), mostly cross-compilation) +* no main loop (or other threading requirements) +* no initialization +* on Windows: + * Explorer shell not required (works in Server Core) + * no other dependencies + * Unicode support +* on macOS: + * only dependency is `osascript`, JXA +* on other UNIXes: + * wraps either one of `matedialog`, `qarma`, `zenity` (in that order of preference) + * no command line support