* Chris Dunder
* Daniel Hahler
* Maciej Sitarz
+* Mathias Svensson
* Matthew R Johnson
+* Nazar Mokrynskyi
* Phillip Berndt
* Rasmus Wriedt Larsen
* Stefan Tomanek
* stormc
* tachylatus
* andersonjacob
+* Simon Wydooghe
-## How to use
+## 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.
-Save your current display configuration and setup with:
+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.
+
+On any distribution with `pip` installed you can install it with:
```
-autorandr --save mobile
+sudo pip install -e git+http://github.com/phillipberndt/autorandr#egg=autorandr
```
+## How to use
+
+Save your current display configuration and setup with:
+
+ 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
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.
+`~/.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
autorandr's state is exposed as environment variables prefixed with `AUTORANDR_`.
The most useful one is `$AUTORANDR_CURRENT_PROFILE`.
-To install autorandr call `make install`.
+## Changelog
+
+* *2016-10-03* Install a desktop file to `/etc/xdg/autostart` by default