First commit

README.md

@@ -0,0 +1,54 @@
+Kanshi Ansible role
+-------------------
+
+This role install and configure [Kanshi](https://git.sr.ht/~emersion/kanshi})
+service.
+
+
+## Variables
+
+This role needs two variables for creating Kanshi configuration file 
+`sway_output` provided by [ansible-sway](https://git.epha.se/ephase/ansible-sway)
+role and `kanshi_profiles`.
+
+`sway_outputs` is not mandatory butuseful to provide id ans options for outputs.
+
+Here is an example of `kanshi_profile`
+
+```yaml
+kanshi_profiles:
+  - profile: 'laptop'
+    screens:
+      - id: 'eDP-1'
+  - profile: 'home'
+    screens:
+    - id: 'eDP-1'
+      enable: false
+    - id: 'iiyama_27_4k'
+      position: '1080,0'
+    - id: 'iiyama_23_fhd'
+      position: '0,0'
+      mode: '1920x1024'
+      transform: 90
+    options:
+      - id: 'eDP-1'
+        option: 'bg'
+        value: '~/images/bg.jpg'
+    commands:
+      - swaymsg workspace 1, move workspace to +eDP1+
+```
+
+ * `profile`: name of the profile
+ * `screens`: list of outputs
+   * `id`: id of the screen, could be the real name, ouput name like *HDMI-1*
+     (both given by `swaymsg -t output`) or id referenced in `sway_outputs`
+   * `position`: absolute position of the screen
+   * `mode`: resolution of the screen
+   * `scale`: scale factor for the screen
+   * `transform`: rotation (90, 180 or 270 degres) for the screen
+ * `options`: list of options:
+   * `id`: see above in *screens* section
+   * `options`: option name
+   * `value`: value
+ * `commands`: list of command to execute when switching to profile
+