diff --git a/README.md b/README.md index aee6b61..c2c7d86 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ This is done to avoid loading of arbitrary plugins that might be placed within t ### Manual compilation Compile the source for the chosen plugin by cloning the repository and building the plugin. -After this, simply compile the plugin and move it to the ReSet plugins folder in your `.config/reset/plugins` directory. +After this, simply compile the plugin and move it to the ReSet plugins folder in your `$xdg_config_dir/reset/plugins` directory. ### Arch Linux @@ -39,3 +39,7 @@ Please visit [the ReSet main application](https://github.com/Xetibo/ReSet) for d ### Flatpak Flatpak does not allow ReSet to ship plugins directly, therefore, you would be required to download the compiled binaries within this repository and manually copy them to the plugin directory as defined in [Confirmation](#confirmation) + +## Configuration + +Configuration can be found in the respective plugin folders. diff --git a/keyboard_plugin/README.md b/keyboard_plugin/README.md index 30730c2..7c093d5 100644 --- a/keyboard_plugin/README.md +++ b/keyboard_plugin/README.md @@ -1,7 +1,16 @@ # ReSet-Keyboard + This plugin features the configuration of keyboard layouts. It offers both a DBus interface and a graphical user interface in order to cover a wide range of users. Note: This plugin uses the XDG standard for handling keyboard layouts, hence only 4 active keyboard layouts are currently allowed. Should a new standard be implemented, this plugin can be adapted for the new standard. ## Environment Support -## Installation -Simply compile the plugin and move it to the ReSet plugins folder in your .config directory. + +## Configuration + +Currently, the only configuration option for this plugin is used by the Hyprland implementation. +It defines where the monitor file is located in which ReSet will write the keyboard configuration for Hyprland to listen to. + +```toml +[Keyboard] +path = "$HOME/.config/reset/keyboard.conf" +``` diff --git a/monitors/README.md b/monitors/README.md index 855d9c4..9baa5c3 100644 --- a/monitors/README.md +++ b/monitors/README.md @@ -12,3 +12,15 @@ This plugin features the configuration of monitors. It offers both a DBus interf Note: various environments support specific features like VRR, primary monitor support and more. These features will be shown dynamically. For GNOME, please ensure that fractional scaling and VRR are enabled in the experimental settings if you would like to use them. +## Configuration + +Currently, two configuration flags are supported: + +- path: the path for the Hyprland implementation file. This file will be used by Hyprland to offer persistent saving of monitor configurations. +- save_warning: this handles whether the warning banner will be shown on incompatible configurations. + +```toml +[Monitor] +path = "$HOME/.config/reset/monitors.conf" +save_warning = true +```