diff --git a/.config/awesome/README.md b/.config/awesome/README.md new file mode 100644 index 0000000..63f4ab6 --- /dev/null +++ b/.config/awesome/README.md @@ -0,0 +1,71 @@ +# My Awesome Configuration + +![Screenshot of my desktop](https://www.gitlab.com/dwt1/dotfiles/raw/master/.screenshots/dotfiles09.png) + +Awesome is a highly configurable, next generation framework window manager for X. + +# Features + +* Simple, small and extensible. It's easy to write your own layouts, + widgets and commands. +* Configured in Python. +* Command shell that allows all aspects of Qtile to be managed and + inspected. +* Complete remote scriptability - write scripts to set up workspaces, + manipulate windows, update status bar widgets and more. +* Qtile's remote scriptability makes it one of the most thoroughly + unit-tested window managers around. + +# My Keybindings + +The MODKEY is set to the Super key (aka the Windows key). + +| Keybinding | Action | +| :--- | :--- | +| `ALT + CRTL + Enter` | opens run launcher (dmenu is the run launcher but can be easily changed) | +| `MODKEY + Enter` | opens terminal (st is the terminal but can be easily changed) | +| `MODKEY + SHIFT + c` | closes window with focus | +| `MODKEY + SHIFT + r` | restarts awesome | +| `MODKEY + SHIFT + q` | quits awesome | +| `MODKEY + j` | switches focus between windows in the stack, going down | +| `MODKEY + k` | switches focus between windows in the stack, going up | +| `MODKEY + SHIFT + j` | rotates the windows in the stack, going down| +| `MODKEY + SHIFT + k` | rotates the windows in the stack, going up | +| `MODKEY + 1-9` | switch focus to workspace (1-9) | +| `MODKEY + SHIFT + 1-9` | sends focused window to workspace (1-9) | + +## Getting Help With Awesome + +#### IRC + +You can join the `#awesome` channel on the [OFTC](http://www.oftc.net/) IRC network. + +[IRC Webchat](https://webchat.oftc.net/?channels=awesome) + +#### Stack Overflow +You can ask questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/awesome-wm). + +#### Reddit +There is an [awesome subreddit](https://www.reddit.com/r/awesomewm/) where you can share your work and ask questions. + +## Reporting issues + +Please report any issues you have with AwesomeWM on [our bugtracker](https://github.com/awesomeWM/awesome/issues). + +## Contributing code + +You can submit pull requests on the [github repository](https://github.com/awesomeWM/awesome). +Please read the [contributing guide](https://github.com/awesomeWM/awesome/blob/master/docs/02-contributing.md) for any coding, documentation or patch guidelines. + +## Status +[![Build Status](https://travis-ci.com/awesomeWM/awesome.svg?branch=master)](https://travis-ci.com/awesomeWM/awesome) + +## Documentation + +Online documentation is available [here](https://awesomewm.org/apidoc/). + +## License + +The project is licensed under GNU General Public License v2 or later. +You can read it online at ([v2](http://www.gnu.org/licenses/gpl-2.0.html) +or [v3](http://www.gnu.org/licenses/gpl.html)).