start docs

README.md

@@ -11,6 +11,55 @@ Ansible role to install and configure weechat.
  - ~~configure weechat~~ *(in progress)*
  - autostart via tmux and systemd
 
+ Settings
+----------
+
+```yaml
+ weechat:
+    install: true
+```
++ ``install: true``: This role should install weechat. On debian based OS we add the official weechat apt source and install some plugin support and weechat-doc.
++ ``install: false``: We do not install weechat
+
+```yaml 
+weechat:
+    autostart: false
+```
++ ``autostart: false``: We do not install any autostart mechanism
++ ``autostart: true``: This role install tmux and creates a systemd service to launch weechat inside a tmux session as user ``{{ weechat.user }}``
+
+```yaml
+weechat:
+  install_plugins: false
+```
++ ``install_plugins: false``: we do not install any weechat plugins
++ ``install_plugins: true``: We do install all official plugins specified in ``{{ weecat.plugins }}`` dict.
+
+```yaml
+weechat:
+  use_custom_config: false
+```
+
+   7   │   # should we install official weechat plugins
+   8   │   install_plugins: false
+   9   │   # custom weechat config (requires some manual interaction for long-term usage)
+  10   │   custom
+  11   │   # user to install and use weechat
+  12   │   user: "{{ ansible_user_id }}"
+  13   │   # where is our home direcotory for weechat
+  14   │   home_directory: "{{ ansible_env.HOME | default('/home/{{ weechat.user }}') }}/.weechat"
+  15   │   # plugins we want
+  16   │   plugins: []
+  17   │   # weechat gpg key for debian/ubuntu repo
+  18   │   gpg_id: '11E9DE8848F2B65222AA75B8D1820DB22A11534E'
+  19   │   # custom private config
+  20   │   costom_config:
+  21   │     # path to your custom weechat config (with plugins) git repo ( git@github.com:<your_name>/<your_weechat_config_repo>.git )
+  22   │     private_repo: false
+  23   │     # generate ssh key pair (if not available)
+  24   │     gen_ssh_key_pair: true
+
+
 
 ```txt
 WARNING

defaults/main.yml

@@ -7,7 +7,7 @@ weechat:
   # should we install official weechat plugins
   install_plugins: false
   # custom weechat config (requires some manual interaction for long-term usage)
-  custom
+  use_custom_config: false
   # user to install and use weechat
   user: "{{ ansible_user_id }}"
   # where is our home direcotory for weechat

vars/main.yml

@@ -21,3 +21,8 @@ _weechat:
   home_directory: "{{ ansible_env.HOME | default('/home/{{ weechat.user }}') }}/.weechat"
   plugins: []
   gpg_id: '11E9DE8848F2B65222AA75B8D1820DB22A11534E'
+  use_custom_config: false
+  costom_config:
+    private_repo: false
+    gen_ssh_key_pair: true
+