awesomewm-mirrors
/
layout-machi
mirror of https://github.com/xinhaoyuan/layout-machi.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

readme

This commit is contained in:
Xinhao Yuan 2019-07-07 14:22:01 -04:00
parent d868c6e7d6
commit 9bc4fde952
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -12,9 +12,9 @@ TL;DR --- I want the control of my layout.
## Use the layout
Use `layotu = layout_machi.layout.create()` to instantiate the layout.
Use `layout = layout_machi.layout.create()` to instantiate the layout.
## Use the editor
## Editor
Call `editor = layout_machi.editor.create()` to create an editor that can either
@ -94,6 +94,10 @@ Tada!
By default, the last 100 command sequences are stored in `~/.machi_history`.
To change that, please refer to `editor.lua`. (XXX more documents)
## Switcher
Calling `layout_machi.switcher.start()` will create a switcher that can (1) move window/focus into other regions by direction keys, and (2) switch windows in the same regions using `Tab` key.
## Other functions
`layout_machi.editor.fit_region(c, cycle)` will fit a floating client into the closest region.