From 21eeb1981861786f4e7c6e075454fb81e0d8fe29 Mon Sep 17 00:00:00 2001 From: vcaesar Date: Fri, 24 Dec 2021 13:50:06 -0400 Subject: [PATCH] Update godoc and README.md --- README.md | 9 +++++++-- README_zh.md | 9 +++++++-- docs/keys.md | 4 ++-- robotgo.go | 2 -- 4 files changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2929e63..ae7ba91 100644 --- a/README.md +++ b/README.md @@ -79,13 +79,18 @@ In the plans, the bitmap.go will moves to the bitmap dir, but break the API. ) #### For everything else: ``` -GCC, libpng +GCC, +libpng (bitmap) X11 with the XTest extension (also known as the Xtst library) Event: xcb, xkb, libxkbcommon + +Clipboard: + +xsel xclip ``` ##### Ubuntu: @@ -104,7 +109,7 @@ sudo apt install xsel xclip ##### Fedora: ```yml -sudo dnf install libxkbcommon-devel libXtst-devel libxkbcommon-x11-devel xorg-x11-xkb-utils-devel +sudo dnf install libXtst-devel libxkbcommon-devel libxkbcommon-x11-devel xorg-x11-xkb-utils-devel sudo dnf install libpng-devel diff --git a/README_zh.md b/README_zh.md index 37fc345..29aa363 100644 --- a/README_zh.md +++ b/README_zh.md @@ -73,13 +73,18 @@ Or you can removed the bitmap.go ) #### For everything else (Linux 等其他系统): ``` -GCC, libpng +GCC, +libpng(bitmap) X11 with the XTest extension (also known as the Xtst library) 事件: xcb, xkb, libxkbcommon + +Clipboard: + +xsel xclip ``` ##### Ubuntu: @@ -98,7 +103,7 @@ sudo apt install xsel xclip ##### Fedora: ```yml -sudo dnf install libxkbcommon-devel libXtst-devel libxkbcommon-x11-devel xorg-x11-xkb-utils-devel +sudo dnf install libXtst-devel libxkbcommon-devel libxkbcommon-x11-devel xorg-x11-xkb-utils-devel sudo dnf install libpng-devel diff --git a/docs/keys.md b/docs/keys.md index 2752833..dff9e22 100644 --- a/docs/keys.md +++ b/docs/keys.md @@ -46,7 +46,7 @@ "cmd" is the "win" key for windows "lcmd" left command "rcmd" right command - "command" + // "command" "alt" "lalt" left alt "ralt" right alt @@ -57,7 +57,7 @@ "shift" "lshift" left shift "rshift" right shift - "right_shift" + // "right_shift" "capslock" "space" "print" diff --git a/robotgo.go b/robotgo.go index 75c0d3a..21027f5 100644 --- a/robotgo.go +++ b/robotgo.go @@ -19,9 +19,7 @@ See Requirements: Installation: With Go module support (Go 1.11+), just import: -```go import "github.com/go-vgo/robotgo" -``` Otherwise, to install the robotgo package, run the command: go get -u github.com/go-vgo/robotgo