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

Improve documentation

This commit is contained in:
Emmanuel Lepage Vallee 2014-03-08 01:00:32 -05:00
parent ebf360dae8
commit 8ae645c597
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -12,6 +12,18 @@ much the same rule configuration, but without all the dynamic tag code. Note
that dynamic tagging is now supported directly by awesome. Tyrannical support
Awesome WM version 3.5 and higher.
### Installation
This is how to install Tyrannical
```
mkdir -p ~/.config/awesome
cd ~/.config/awesome
git clone https://github.com/Elv13/tyrannical.git
```
Then either use the sample rc.lua or upgrade your existing one.
### Examples
Install [Xephyr](http://www.freedesktop.org/wiki/Software/Xephyr) and run the
@ -214,6 +226,12 @@ anymore. Awful's dynamic tag implementation is compatible with Tyrannical. See
the [API](http://awesome.naquadah.org/doc/api/) and this
[user contribution](https://github.com/Elv13/tyrannical/issues/15#issuecomment-18227575)
#### How do I get a client class?
From a terminal, execute `xprop`, then click on an instance of that client.
There will be a "CLASS" line with one or more class. Always pick the first one,
Tyrannical is not case sensitive.
#### Is it possible to have relative indexes (position) for tags?
Tyrannical shares awful's tag list. It does not keep its own indexes since this