diff --git a/README.md b/README.md index 4caf090adb73d5cc3c6baf87dead785ed9172a4d..8ce5cf200ffa58f82eaf20b7d21b12cad1d31cd8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Extension providing a grid layout for awesomeWM 4.3 -awesomeWM https://github.com/awesomeWM/awesome +awesomeWM <https://github.com/awesomeWM/awesome> ## Installation @@ -9,7 +9,7 @@ Clone this repo, for ease of use in the same folder where `rc.lua` is. Add something like: ``` lua --- Include taggrid, a mxn grid of tags +-- Include taggrid, a m x n grid of tags taggrid = require("taggrid.taggrid") taggridkeys = require("taggrid.taggridkeys") ``` @@ -116,9 +116,46 @@ globalkeys = taggridkeys(globalkeys) ## Styling/looks -To make the numbers fit the tags modify your theme with: +Useful properties for tuning the size: ``` lua theme.taglist_font = "Terminus 4" +-- Not needed, will autoadjust to content +--theme.wibar_height = 30 ``` +## Example + +Scaled up on a low resolution 1280x800 screen, wibar_height = 50, "Terminus 7": + + + +On the same screen (12") running with taglist_font = "Terminus 4": + + + +## Usage + +Awesome use the keycodes directly, so the whole number row, from number 1 to 9 continuing towards the backspace key on my Swedish keyboard. + +This provides direct access to 13 tags. + +``` +Modkey + (1 to 9), Modkey + 0, Modkey + [, Modkey + ], Modkey + "Backspace" +``` + +The same modifiers as in stock awesome for toggling views and tags. + +Supports moving between tags in all directions: + +``` +Modkey + ArrowKeys(Up, Down, Left, Right) +Modkey + < +Modkey + > +``` + +Add "Shift" for shifting the currently focused client. + +Scrolling on the tagbar will cycle through all tags, using the movement keys it will wrap around on the current row. Similar behaviour for shifting clients. + +See `taggridkeys.lua` for more details. \ No newline at end of file diff --git a/images/taggrid-fulldesktop.png b/images/taggrid-fulldesktop.png new file mode 100644 index 0000000000000000000000000000000000000000..a0b4092e04c40c5d1a209aea10648cf5f16dde1c Binary files /dev/null and b/images/taggrid-fulldesktop.png differ diff --git a/images/taggrid-wibarheight50-font7.png b/images/taggrid-wibarheight50-font7.png new file mode 100644 index 0000000000000000000000000000000000000000..bd762710145b6cfe20130c62bbc17ad7b0a99ba3 Binary files /dev/null and b/images/taggrid-wibarheight50-font7.png differ