X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README.md;h=070a453f20c500c0e4d763c8657912e2a995de2c;hb=986e5cfaf68e695483c7d388e4ea093a28862445;hp=150de3f7a110485dd7712b458acf179969a19744;hpb=ca1720207e187a9f78b5ce2f515bf3042e2e3a4a;p=deb_pkgs%2Fautorandr.git

diff --git a/README.md b/README.md
index 150de3f..070a453 100644
--- a/README.md
+++ b/README.md
@@ -34,34 +34,57 @@ Contributors to this version of autorandr are:
 
 * Alexander Wirt
 * Chris Dunder
+* Daniel Hahler
 * Maciej Sitarz
+* Mathias Svensson
 * Matthew R Johnson
+* Nazar Mokrynskyi
 * Phillip Berndt
 * Rasmus Wriedt Larsen
 * Stefan Tomanek
 * Timo Bingmann
 * Tomasz Bogdal
+* Victor Häggqvist
 * stormc
 * tachylatus
+* andersonjacob
+* Simon Wydooghe
+
+## Installation/removal
+You can use the `autorandr.py` script as a stand-alone binary. If you'd like to
+install it as a system-wide application, there is a Makefile included that also
+places some configuration files in appropriate directories such that autorandr
+is invoked automatically when a monitor is connected or removed, the system
+wakes up from suspend, or a user logs into an X11 session.
+
+For Debian-based distributions (including Ubuntu) it is recommended to call
+`make deb` to obtain a package that can be installed and removed with `dpkg`.
+
+On Arch Linux, there is [an aur package
+available](https://aur.archlinux.org/packages/autorandr-git/).
+
+On other distributions you can install autorandr by calling `make install` and
+remove it by calling `make uninstall`. Run `make` without arguments to obtain a
+list of what exactly will be installed.
+
+We appreciate packaging scripts for other distributions, please file a pull
+request if you write one.
 
 ## 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:
-```
- $ autorandr
-   mobile
-   docked (detected)
-```
+
+    $ autorandr
+      mobile
+      docked (detected)
 
 To automatically reload your setup, just append `--change` to the command line
 
@@ -77,12 +100,29 @@ to query the status of a docking station you are about to leave.
 
 If no suitable profile can be identified, the current configuration is kept.
 To change this behaviour and switch to a fallback configuration, specify
-`--default <profile>`.
+`--default <profile>`. The system-wide installation of autorandr by default
+calls autorandr with a parameter `--default default`. There are three special,
+virtual configurations called `horizontal`, `vertical` and `common`. They
+automatically generate a configuration that incorporates all screens
+connected to the computer. You can symlink `default` to one of these
+names in your configuration directory to have autorandr use any of them
+as the default configuration without you having to change the system-wide
+configuration.
 
 Another script called `postswitch` can be placed in the directory
-`~/.config/autorandr` (or `~/.autorandr` if you have an old installation) as well as in all profile directories: The scripts are executed
-after a mode switch has taken place and can notify window managers or other
-applications about it.
-
-To install autorandr call `make install`, define your setup and then call
-`make hotplug` to install hotplug scripts.
+`~/.config/autorandr` (or `~/.autorandr` if you have an old installation) as
+well as in all profile directories: The scripts are executed after a mode
+switch has taken place and can notify window managers or other applications
+about it. The same holds for `preswitch`, which is executed before the switch
+takes place, and `postsave`, which is executed after a profile was
+stored/altered.
+
+All scripts can also be placed in any of the `$XDG_CONFIG_DIRS`. In addition to
+the script names themselves, any executables in subdirectories named
+`script_name.d` (e.g. `postswitch.d`) are executed as well. In scripts, some of
+autorandr's state is exposed as environment variables prefixed with `AUTORANDR_`.
+The most useful one is `$AUTORANDR_CURRENT_PROFILE`.
+
+## Changelog
+
+* *2016-10-03* Install a desktop file to `/etc/xdg/autostart` by default