From 385af67f91ee42274a8e6d45423f22055ac9b217 Mon Sep 17 00:00:00 2001 From: Ein Verne Date: Mon, 14 Sep 2020 18:56:05 +0800 Subject: [PATCH] Hammerspoon: Update Readme --- hammerspoon/README.md | 66 +++++++++++++++++++++---------------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/hammerspoon/README.md b/hammerspoon/README.md index d4f3807..273dc1e 100644 --- a/hammerspoon/README.md +++ b/hammerspoon/README.md @@ -13,6 +13,11 @@ hammerspoon is my configuration for [Hammerspoon](http://www.hammerspoon.org/). `cd ~/dotfiles && git pull` +## File structure + +- `autoscript.lua`, auto commit and push my personal notes. +- `ime.lua`, auto switch different Input methods in different applications + ## How to use Use Karabier-Elements to set caps lock as hyper key. Press caps lock is just like press Cmd+Control+Option+Shift at the same time. @@ -46,7 +51,7 @@ I personally use the application called Context to switch between different wind ## Toggle hammerspoon console -Option+z +`Option+z` ## Move windows between monitors @@ -55,12 +60,26 @@ Option+z ### Application launcher -Press option + a to enter application launcher. The shorcut information will show on the center of the screen. But I personally prefer Alfred. +Press `option + a` to enter application launcher. The shorcut information will show on the center of the screen. But I personally prefer Alfred. + +## Hammerspoon API manual + +`Option+h` open Hammerspoon API manual. + +## Lock screen +`Option+l` to lock screen. + +## Show time in the middle of screen +`Option+t` to toggle the time in screen. -Just press opt, plus A or C or R… to start. If need help, press tab to toggle the keybindings cheatsheet. +## Auto type url in markdown format -Press opt + ? to toggle the help panel, which will show all opt related keybindings. +`Option+v` to auto type url in markdown format. + +## Toggle Hammerspoon console + +`Option+z` to toggle Hammerspoon console. ### Screenshots @@ -68,22 +87,16 @@ These screenshots demostrate what awesome-hammerspoon is capable of. Learn more #### Desktop widgets - ![widgets](https://github.com/ashfinal/bindata/raw/master/screenshots/awesome-hammerspoon-deskwidgets.png) #### Window manpulation ⌥ + R - ![winresize](https://github.com/ashfinal/bindata/raw/master/screenshots/awesome-hammerspoon-winresize.gif) - #### aria2 Frontend ⌥ + D - -![hsearch](https://github.com/ashfinal/bindata/raw/master/screenshots/awesome-hammerspoon-aria2.png) - You need to [run aria2 with RPC enabled](https://github.com/ashfinal/awesome-hammerspoon/wiki/Run-aria2-with-rpc-enabled) before using this. Config aria2 host and token in `~/.hammerspoon/private/config.lua`, then you're ready to go. ```lua @@ -111,39 +124,26 @@ Then modify the file `~/.hammerspoon/private/config.lua`: Please read `~/.hammerspoon/private/config.lua`for more details. -Finally press `cmd + ctrl + shift + r` to reload the configuration. - - -## Contribute - -- Improve existing Spoons +## Reference +Some resources you may find helpful: - A "Spoon" is just a directory, right-click on it -> "Show Package Contents". +- [Learn Lua in Y minutes](http://learnxinyminutes.com/docs/lua/) - Feel free to file issues or open PRs. +- [Getting Started with Hammerspoon](http://www.hammerspoon.org/go/) -- Create new Spoons +- [Hammerspoon API Docs](http://www.hammerspoon.org/docs/index.html) - Some resources you may find helpful: - - [Learn Lua in Y minutes](http://learnxinyminutes.com/docs/lua/) - - [Getting Started with Hammerspoon](http://www.hammerspoon.org/go/) - - [Hammerspoon API Docs](http://www.hammerspoon.org/docs/index.html) - - [hammerspoon/SPOONS.md at master · Hammerspoon/hammerspoon](https://github.com/Hammerspoon/hammerspoon/blob/master/SPOONS.md) +- [hammerspoon/SPOONS.md at master · Hammerspoon/hammerspoon](https://github.com/Hammerspoon/hammerspoon/blob/master/SPOONS.md) ## Thanks to +- [https://github.com/zzamboni/oh-my-hammerspoon](https://github.com/zzamboni/oh-my-hammerspoon) -[https://github.com/zzamboni/oh-my-hammerspoon](https://github.com/zzamboni/oh-my-hammerspoon) - -[https://github.com/scottcs/dot_hammerspoon](https://github.com/scottcs/dot_hammerspoon) +- [https://github.com/scottcs/dot_hammerspoon](https://github.com/scottcs/dot_hammerspoon) -[https://github.com/dharmapoudel/hammerspoon-config](https://github.com/dharmapoudel/hammerspoon-config) +- [https://github.com/dharmapoudel/hammerspoon-config](https://github.com/dharmapoudel/hammerspoon-config) -[http://tracesof.net/uebersicht/](http://tracesof.net/uebersicht/) +- [http://tracesof.net/uebersicht/](http://tracesof.net/uebersicht/)