diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4daf8ed --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# README for arandr-trayicon +A system tray icon for easily changing monitor settings. + +## Upstream +This project's upstream is at <https://bgstack15.ddns.net/cgit/arandr-trayicon/> + +## Alternatives +Xfce4-settings includes a program, **xfce4-display-settings**, which is really nice but needs more components of xfce4 than I was willing to research and install. A full Xfce4 suite will handle it. + +## Reason for existence +I wanted a lightweight tray icon that lets a user easily change which displays are active. Arandr would obviously be very useful but some users don't even want to use that. + +## Using +Run `arandr-trayicon` in your graphical session, probably at startup. For fluxbox, that would be in `~/.fluxbox/startup`. + +## Configuring +The application examines all the arandr-generated `~/.screenlayout/*.sh` scripts and also admin-set ones at `/etc/screenlayouts/*.sh`. The filenames are displayed as menu entries on the system tray. A good plan is for an admin to install the package/script, and then define for the system some basic scripts in `/etc/screenlayouts/`, including: + + laptop-only.sh + extend-desktop.sh + hdmi-only.sh + mirror-displays.sh + +## Dependencies + +* xrandr +* arandr for setup of initial display-settings scripts + +## Building +If applicable, or more complicated than `make && make install`. + + +## Improvements + +* Still need packaging recipes + +## References |