Add README.md

README.md

@@ -0,0 +1,58 @@
+Collision window management module for AwesomeWM
+================================================
+
+This module add some visual indicators for common window management operations.
+It is now easier to know the impact of a given command as a visual queue will
+be printed on the screen. Collision has 3 modes:
+
+* **Focus**: Move the focus from client to client
+* **Move**: Move a client
+* **Resize**: Change a client dimensions
+
+# Installation
+
+First, clone the repository
+
+```lua
+    mkdir -p ~/.config/awesome
+    cd ~/.config/awesome
+    git clone https://github.com/Elv13/Collision
+```
+
+Now, open ~/.config/awesome/rc.lua (or copy /etc/xdg/awesome/rc.lua to 
+~/.config/awesome/rc.lua fist if you never modified your Awesome config before)
+ and add this line at the **end** of rc.lua:
+
+```lua
+    require("collision")()
+```
+
+It is a very good idea to also change the default `mod4+arrow` shortcut to
+something else:
+
+```lua
+    --Change
+    awful.key({ modkey,           }, "Left",   awful.tag.viewprev       ),
+    awful.key({ modkey,           }, "Right",  awful.tag.viewnext       ),
+
+    --To (re-use Unity/Compiz old shortcuts for desktop navigation)
+    awful.key({ "Mod1", "Control" }, "Left",   awful.tag.viewprev       ),
+    awful.key({ "Mod1", "Control" }, "Right",  awful.tag.viewnext       ),
+```
+
+Your done!
+
+# Usage
+
+Using Collision is easy. You just have to hit the arrow keys (`➡` `⬆` `⬇` `⬅`)
+with some modifiers keys. The `Shift` key is usually used for grabbing something
+while the `Control` key is used to max out the effect.
+
+| Modifier 1 | Modifier 2 | Modifier 3 | Effect                                                |
+| ---------- | ---------- | ---------- | :---------------------------------------------------: |
+| Mod4       |            |            | Move the focus om the tiled layer                     |
+| Mod4       |            | Control    | Move the focus on the floating layer                  |
+| Mod4       | Shift      |            | Move a client in the tiled or floating layer          |
+| Mod4       | Shift      | Control    | Move a floating client to the far side of that screen |
+| Mod4       | Mod1 (Alt) |            | Resize a client relative to the bottom right corner   |
+| Mod4       | Mod1 (Alt) | Shift      | Resize a client relative to the top left corner       |