X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README.md;h=fdfb54712d3c77d4515aadd5e809dc6e5b41f5e3;hb=53f7af43c6e0d597ebe7836c2d9aab94cc5d28d3;hp=9401d37d3dd1ea562c3ed9c391ee1d48c3793861;hpb=770498dbb1608a25c562db5b3cbf75c3bbd3374c;p=deb_pkgs%2Fautorandr.git diff --git a/README.md b/README.md index 9401d37..fdfb547 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,51 @@ -# autorandr - +# autorandr 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). + The original [wertarbyte/autorandr](https://github.com/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. +tree is unmaintained, with lots of open pull requests and issues. I forked it +and merged what I thought were the most important changes. If you are searching +for that version, see the [`legacy` branch](https://github.com/phillipberndt/autorandr/tree/legacy). +Note that the Python version is better suited for non-standard configurations, +like if you use `--transform` or `--reflect`. If you use `auto-disper`, you +have to use the bash version, as there is no disper support in the Python +version (yet). Both versions use a compatible configuration file format, so +you can, to some extent, switch between them. I will maintain the `legacy` +branch until @wertarbyte finds the time to maintain his branch again. + +If you are interested in why there are two versions around, see +[#7](https://github.com/phillipberndt/autorandr/issues/7), +[#8](https://github.com/phillipberndt/autorandr/issues/8) and +especially +[#12](https://github.com/phillipberndt/autorandr/issues/12) +if you are unhappy with this version and would like to contibute to the bash +version. ## License information and authors -Stefan Tomanek came up with and wrote the initial version of autorandr. He -currently does not maintain it, and did not express his opinion concerning an -OSS license in two independent requests. To resolve the licensing issue, all -non-trivial code in this fork has been reimplemented by various authors that -have agreed to release their code under the terms of the GNU General Public -License (version 3). - -This license will apply to versions of autorandr from this fork that are -committed after issue #7 has been resolved, and versions derived from that one. -**In particular, wertarbyte's original repository is still not OSS, and the current -version in this repository is neither.** +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 +* Daniel Hahler * Maciej Sitarz * Matthew R Johnson * Phillip Berndt +* Rasmus Wriedt Larsen +* Stefan Tomanek * Timo Bingmann * Tomasz Bogdal +* Victor Häggqvist * stormc * tachylatus +* andersonjacob ## How to use @@ -71,26 +83,8 @@ To change this behaviour and switch to a fallback configuration, specify `--default `. Another script called `postswitch` can be placed in the directory -`~/.autorandr` as well as in all profile directories: The scripts are executed +`~/.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. -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. - -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` +To install autorandr call `make install`.