Merge branch 'rate' into license

[deb_pkgs/autorandr.git] / README.md

diff --git a/README.md b/README.md
index f6a5bdb144c8519234ab133c19344dc817c524ab..02242716bdff312f6e192304f9133c0c65e33d60 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,16 +1,43 @@
-# Tool: autorandr
+# autorandr
 
 Automatically select a display configuration based on connected devices
 
-### Stefan Tomanek <[stefan.tomanek@wertarbyte.de](stefan.tomanek@wertarbyte.de)>
+## Branch information
 
-# How to use:
+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
+* Stefan Tomanek
+* Timo Bingmann
+* Tomasz Bogdal
+* stormc
+* tachylatus
+
+## How to use
 
 Save your current display configuration and setup with:
-```autorandr --save mobile```
+```
+autorandr --save mobile
+```
 
 Connect an additional display, configure your setup and save it:
-```autorandr --save docked```
+```
+autorandr --save docked
+```
 
 Now autorandr can detect which hardware setup is active:
 ```
@@ -40,8 +67,22 @@ Another script called `postswitch` can be placed in the directory
 after a mode switch has taken place and can notify window managers or other
 applications about it.
 
+While the script uses xrandr by default, calling it by the name `autodisper`
+or `auto-disper` forces it to use the [disper](http://willem.engen.nl/projects/disper/)
+utility, which is useful for controlling nvidia chipsets. The formats for
+fingerprinting the current setup and saving/loading the current configuration
+are adjusted accordingly.
+
+To install autorandr call `make install`, define your setup and then call
+`make hotplug` to install hotplug scripts.
 
-While the script uses xrandr by default, calling it by the name __autodisper__
-or "auto-disper" forces it to use the "disper" utility, which is useful for
-controlling nvidia chipsets. The formats for fingerprinting the current setup
-and saving/loading the current configuration are adjusted accordingly.
+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`