diff --git a/README.md b/README.md index 5c35788..0499392 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,28 @@ Role to configure Sway window manager ## Variables -This role have multiples variables for managing all configurations +This role have multiples variables for managing all configurations, all +variables are initalized to reproduce default configuration. + +There is no bar configured by this role because it is out of his scope. A futur +role will be created for installing and configuring Waybar. + +### Packages + +`sway_packages` list packages to install. + +### variables + +`sway_variables` contains a list of variable needed for configuration files like +`$term` or `$menu` + +```yaml +sway_variables: + - name: '$term' + value: 'foot' + - name: '$menu' + value: 'dmenu_path | dmenu | xargs swaymsg exec --' +``` ### output @@ -126,9 +147,9 @@ sway_rules: # ... ``` -`sway_workspace` represent a list of workspaces defined by a *key* that represent the -keyboard key to press with `$mod` to access this workspace and a *value* that -represent the workspace name. +`sway_workspace` represent a list of workspaces defined by a *key* that +represent the keyboard key to press with `$mod` to access this workspace and a +*value* that represent the workspace name. `sway_rules` reprensents the list of rules for managing windows :