Skip to content

Commit

Permalink
readme: update all readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
DashieTM committed Jun 6, 2024
1 parent 2e83fd9 commit 5fef53a
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 3 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
13 changes: 11 additions & 2 deletions keyboard_plugin/README.md
Original file line number Diff line number Diff line change
@@ -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"
```
12 changes: 12 additions & 0 deletions monitors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit 5fef53a

Please sign in to comment.