gurkan/loose
gurkan/loose
1
0
Fork 0
Code Issues 3 Activity

Better organization for README

Browse source
This commit is contained in:
Gürkan 2023-12-17 00:27:38 +01:00
parent ed693e6f09
commit 9832f9755c
1 changed files with 22 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -2,14 +2,14 @@
This is a helper tool to apply vague Xrandr configurations
> This is still an alpha software, use at your own risk. I am planning to add some features and polish it a bit more before calling it stable.
> This is still an alpha software, use at your own risk. I am planning to add some features and polish it a bit more before recommending it.
### Why?
(Warning: Includes rant)
I wrote this as a reaction to all other xrandr automation tools which requires you to exactly define your setup (e.g. which monitor has which damn fingerprint, what input name it has etc.) and then failing to set up since you plugged a cable on different port.
I wrote this as a reaction to all other xrandr automation tools which requires you to exactly define your setup (e.g. which monitor has which damn fingerprint, what input name it has etc.) and then failing to set up, since you plugged a cable on a different port.
Come on dude, I just want to define some non-specific settings. Something like:
Come on, I just want to define some non-specific settings. Something like:
- If I plug 1 extra monitor, my preference list:
1. Switch off the laptop's monitor and only use plugged monitor
@ -19,7 +19,24 @@ Come on dude, I just want to define some non-specific settings. Something like:
1. Switch off the laptop's monitor and use monitor 1 on the left, 2 on the right
2. Switch off the laptop's monitor and use monitor 2 on the left, 1 on the right
### Installation (TODO?)
### Features
- Configured with a yaml file (I know, I know..)
- Accepts both explicit monitor names and aliases to define purposefully vague configurations
- Supports setting the resolution, rotation, (relative) position, refresh rate and primary monitor
- If you don't define a setting (e.g. resolution or refresh rate), it will apply the "preferred" one from Xrandr
- Supports multiple pre/post commands to run before/after applying the configuration (e.g. to set the DPI)
- Supports multiple configurations for multiple screen counts so you can "rotate" if you don't like the first applied one
- It will try to detect the suitable devices for given aliases consistently (thus you can declare self-correcting preferences like "2 monitors" example above)
- Something failed bad? Then it will try the global failback option defined in the config
I highly recommend checking the [example config](loose/example_config.yaml) for examples and explanations.
Also:
![protip: it was hard](https://paste.gurkan.in/good-sculpin.jpg)
### Installation (What installation?)
Since I am using NixOS, I will be using this with dark magic. Instructions for other distros are welcome, since this tool will be maximally useful if it is installed system-wide and triggered by udev automatically.
@ -28,24 +45,6 @@ For the testing/development purposes, you can use poetry:
- Install poetry
- Run `poetry install` in the repo
### Usage
- Set up your desired configuration in a yaml file after reading the [example config](loose/example_config.yaml)
- You can declare either explicit monitor names or just alises which starts with underscore while writing your configuration
- Check if the config is valid with `loose show`
- Once dust settles after screen connections, trigger `loose rotate`
- It doesn't care if external monitor referred by the name "DP-1", "DP1", "DP-1-2" or "duck99"
- It will detect and apply first preference
- You didn't like this preference? Just trigger `rotate` command again (preferably bound to a keyboard shortcut), and it will switch to next declared preference
- For non-explicit names, it will try to be consistent with detection of screen names (thus you can declare self-correcting preferences like "2 monitors" example above)
- If you don't give specific resolution, it'll use the preferred one (which comes from `xrandr` itself)
- Something failed bad? Then it will try the global failback (which is defined in config file)
Please see [example config](loose/example_config.yaml) for examples and explanations.
Also:
![protip: it was hard](https://paste.gurkan.in/good-sculpin.jpg)
### TODO
Moved to [issues](https://git.gurkan.in/gurkan/loose/issues)
Todo is tracked on my [issues](https://git.gurkan.in/gurkan/loose/issues) page.