Merge remote-tracking branch 'mtahmed/master'

[deb_pkgs/autorandr.git] / README.md

diff --git a/README.md b/README.md
index f6a5bdb144c8519234ab133c19344dc817c524ab..aa66042483e9730266d6635c8379b5d7b310bc05 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,16 +1,28 @@
-# Tool: autorandr
+# autorandr
 
 Automatically select a display configuration based on connected devices
 
-### Stefan Tomanek <[stefan.tomanek@wertarbyte.de](stefan.tomanek@wertarbyte.de)>
+Stefan Tomanek <[stefan.tomanek@wertarbyte.de](stefan.tomanek@wertarbyte.de)>
 
-# How to use:
+## 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.
+
+
+## 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 +52,11 @@ 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.
 
-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.
+To install autorandr call `make install`, define your setup and then call
+`make hotplug` to install hotplug scripts.