summaryrefslogtreecommitdiff
path: root/vendor/github.com/getlantern/systray/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/getlantern/systray/README.md')
-rw-r--r--vendor/github.com/getlantern/systray/README.md50
1 files changed, 0 insertions, 50 deletions
diff --git a/vendor/github.com/getlantern/systray/README.md b/vendor/github.com/getlantern/systray/README.md
deleted file mode 100644
index 626c132..0000000
--- a/vendor/github.com/getlantern/systray/README.md
+++ /dev/null
@@ -1,50 +0,0 @@
-Package systray is a cross platfrom Go library to place an icon and menu in the notification area.
-Tested on Windows 8, Mac OSX, Ubuntu 14.10 and Debian 7.6.
-
-## Usage
-```go
-func main() {
- // Should be called at the very beginning of main().
- systray.Run(onReady, onExit)
-}
-
-func onReady() {
- systray.SetIcon(icon.Data)
- systray.SetTitle("Awesome App")
- systray.SetTooltip("Pretty awesome超级棒")
- mQuit := systray.AddMenuItem("Quit", "Quit the whole app")
-
- // Sets the icon of a menu item. Only available on Mac.
- mQuit.SetIcon(icon.Data)
-}
-
-func onExit() {
- // clean up here
-}
-```
-Menu item can be checked and / or disabled. Methods except `Run()` can be invoked from any goroutine. See demo code under `example` folder.
-
-## Platform specific concerns
-
-### Linux
-
-```sh
-sudo apt-get install libgtk-3-dev libappindicator3-dev
-```
-Checked menu item not implemented on Linux yet.
-
-## Try
-
-Under `example` folder.
-Place tray icon under `icon`, and use `make_icon.bat` or `make_icon.sh`, whichever suit for your os, to convert the icon to byte array.
-Your icon should be .ico file under Windows, whereas .ico, .jpg and .png is supported on other platform.
-
-```sh
-go get
-go run main.go
-```
-
-## Credits
-
-- https://github.com/xilp/systray
-- https://github.com/cratonica/trayhost