Run xrandr disabling connected, but inactive outputs before any other xrandr commands

[deb_pkgs/autorandr.git] / README.md

diff --git a/README.md b/README.md
index aa66042483e9730266d6635c8379b5d7b310bc05..f3f8d32dfe7db62ae47fc61b02efb1d7936ea1c9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,15 +2,47 @@
 
 Automatically select a display configuration based on connected devices
 
-Stefan Tomanek <[stefan.tomanek@wertarbyte.de](stefan.tomanek@wertarbyte.de)>
-
 ## Branch information
 
-The original wertarbyte/autorandr tree seems unmaintained, with lots of open
-pull requests and issues. I forked it and merged what I thought were the most
-important changes. I will maintain this branch until wertarbyte finds the time
-to maintain his branch again.
+The original [wertarbyte/autorandr](https://github.com/wertarbyte/autorandr)
+tree is unmaintained, with lots of open pull requests and issues. I forked
+it and merged what I thought were the most important changes. I will maintain
+this branch until @wertarbyte finds the time to maintain his branch again.
+
+## License information and authors
+
+autorandr is available under the terms of the GNU General Public License
+(version 3).
+
+Contributors to this version of autorandr are:
+
+* Alexander Wirt
+* Chris Dunder
+* Maciej Sitarz
+* Matthew R Johnson
+* Phillip Berndt
+* Rasmus Wriedt Larsen
+* Stefan Tomanek
+* Timo Bingmann
+* Tomasz Bogdal
+* stormc
+* tachylatus
 
+## autorandr vs. autorandr.py
+
+The two files `autorandr` and `autorandr.py` are two independent versions of
+autorandr. For now, both are here, but I might move one of both versions into
+its own branch or repository someday. See [bug #7](https://github.com/phillipberndt/autorandr/issues/7)
+for details on why there are two versions around.
+
+The two versions are compatible with respect to the profile format and command
+line parameters, but
+
+* the *Python version* does not support auto-disper
+* the *bash version* does not support changes in available adapters and slightly esoteric configurations (like transformations and reflections)
+
+Active development in this repository is likely to occur preferably in the
+Python version.
 
 ## How to use
 
@@ -60,3 +92,14 @@ are adjusted accordingly.
 
 To install autorandr call `make install`, define your setup and then call
 `make hotplug` to install hotplug scripts.
+
+For Debian using auto-disper:
+To make the screen auto-configure when your computer wakes up,
+* Copy auto-disper into /usr/local/bin/
+* Copy pm-utils/40auto-disper into /etc/pm/sleep.d/
+* (Assuming gnome) Run gnome-keybinding-properties and ADD a shortcut,
+  I called it "Run auto-disper", I set it to CTRL-F7, and the command is:
+  `auto-disper -c --default default`
+* Create a default disper setting... eg for laptop: unplug all monitors,
+  set up the screen nicely on the laptop display.
+  Then run `auto-disper --save laptop`