discuss contributions in README

[deb_pkgs/autorandr.git] / README.md

diff --git a/README.md b/README.md
index 4fbb38dff10ca049b95fcc71a49b19b4fdfd5ca9..30ab8c76f6aef27713ac9fb96aff07ce59b8b322 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Automatically select a display configuration based on connected devices
 ## Branch information
 
 This is a compatible Python rewrite of
-[wertarbyte/autorandr](https://github.com/wertarbyte/autorandr).
+[wertarbyte/autorandr](https://github.com/wertarbyte/autorandr). Contributions for bash-completion, fd.o/XDG autostart, Nitrogen, pm-utils, and systemd can be found under [contrib](contrib/).
 
 The original [wertarbyte/autorandr](https://github.com/wertarbyte/autorandr)
 tree is unmaintained, with lots of open pull requests and issues. I forked it
@@ -74,6 +74,14 @@ If you prefer `pip` over your package manager, you can install autorandr with:
 
     sudo pip install "git+http://github.com/phillipberndt/autorandr#egg=autorandr"
 
+or simply
+
+       sudo pip install autorandr
+
+if you prefer to use a stable version.
+
+Automatically generated packages versions are available from the
+[openSUSE build service](https://build.opensuse.org/package/show/home:phillipberndt/autorandr).
 
 ## How to use
 
@@ -122,6 +130,11 @@ 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.
 
+If you experience issues with xrandr being executed too early after connecting
+a new monitor, then you can create a script `predetect`, which will be executed
+before autorandr attempts to run xrandr. Place e.g. `sleep 1` into that file
+to make autorandr wait a second before running xrandr.
+
 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
@@ -130,4 +143,15 @@ The most useful one is `$AUTORANDR_CURRENT_PROFILE`.
 
 ## Changelog
 
+* *2017-07-16* Skip `--panning` unless it is required (See #72)
+
+**autorandr 1.1**
+
+* *2017-06-07* Call systemctl with `--no-block` from udev rule (See #61)
+* *2017-01-20* New script hook, `predetect`
+* *2017-01-18* Accept comments (lines starting with `#`) in config/setup files
+
+**autorandr 1.0**
+
+* *2016-12-07* Tag the current code as version 1.0.0; see github issue #54
 * *2016-10-03* Install a desktop file to `/etc/xdg/autostart` by default