From 89d147d6e648e836102f65a515fc4696621a7d05 Mon Sep 17 00:00:00 2001 From: Thomas Ruoff Date: Mon, 28 Jul 2014 17:02:59 +0200 Subject: [PATCH] add README --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4307e1b..4a65f2a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ -switchmon -========= +# SWM - Switch Monitors + +Simple helper for turning on/off connected/disconnected monitors with `xrandr`. + +It uses `xrandr` to detect on which connectors there are monitors connected. It +then runs `xrandr` and sets all disconnected monitors to `off` and all connected +monitors to `on`. + +Monitors will be turned on with xrandr `--auto` option which tries to detect +the optimal video setting. + +If there are multiple monitors connected, each monitor is placed to the right +of the previous monitor. This order is currently driven as xrandr lists the +connectors.