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-11 12:59:21 -04:00
parent c578140bef
commit 406ef51c54
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -10,10 +10,24 @@ TL;DR --- I want the control of my layout.
2. I don't want to have all windows moving around whenever a new window shows up.
3. I want to have a flexible layout such that I can quickly adjust to whatever I need.
## Quick usage
Suppose this git is checked out at `~/.config/awesome/layout-machi`
```
machi = { layout = require("layout-machi.layout"), editor = require("layout-machi.editor"), switcher = require("layout-machi.switcher") }
machi_editor = machi.editor.create()
machi_layout = machi.layout.create("default", machi_editor)
```
Then add the `machi_layout` in your tag layouts
## Use the layout
Use `layout = layout_machi.layout.create(name, editor)` to instantiate the layout with an editor object (see below on creating the editor).
The editor will restore the last regions of the layouts based on their names.
You can also create multiple layouts with different names and share the same editor.
The editor will restore the last setups of the layouts based on their names.
## Editor