Update README and screenshot
This commit is contained in:
parent
d9b868077a
commit
cd2e1959b0
27
README.md
27
README.md
@ -5,7 +5,9 @@
|
||||
wdisplays is a graphical application for configuring displays in Wayland
|
||||
compositors. It borrows some code from [kanshi]. It should work in any
|
||||
compositor that implements the wlr-output-management-unstable-v1 protocol,
|
||||
including [sway].
|
||||
including [sway]. The goal of this project is to allow precise adjustment of
|
||||
display settings in kiosks, digital signage, and other elaborate multi-monitor
|
||||
setups.
|
||||
|
||||
![Screenshot](wdisplays.png)
|
||||
|
||||
@ -13,6 +15,7 @@ including [sway].
|
||||
|
||||
Build requirements are:
|
||||
|
||||
- meson
|
||||
- GTK+3
|
||||
- epoxy
|
||||
- wayland-client
|
||||
@ -23,6 +26,28 @@ ninja -C build
|
||||
sudo ninja -C build install
|
||||
```
|
||||
|
||||
Binaries are not available. Only building from source is supported, and only
|
||||
if you're using wlroots compiled from master.
|
||||
|
||||
# Usage
|
||||
|
||||
Displays can be moved around the virtual screen space by clicking and dragging
|
||||
them in the preview on the left panel. By default, they will snap to one
|
||||
another. Hold Shift while dragging to disable snapping. You can click and drag
|
||||
with the middle mouse button to pan. Zoom in and out either with the buttons on
|
||||
the top left, or by holding Ctrl and scrolling the mouse wheel. Fine tune your
|
||||
adjustments in the right panel, then click apply.
|
||||
|
||||
There are some options available by clicking the menu button on the top left:
|
||||
|
||||
- Automatically Apply Changes: Makes it so you don't have to hit apply. Disable
|
||||
this for making minor adjustments, but be careful, you may end up with an
|
||||
unusable setup.
|
||||
- Show Screen Contents: Shows a live preview of the screens in the left panel.
|
||||
Turn off to reduce energy usage.
|
||||
- Overlay Screen Names: Shows big names in the corner of all screens for easy
|
||||
identification. Disable if they get in the way.
|
||||
|
||||
# FAQ (Fervently Anticpiated Quandaries)
|
||||
|
||||
### What is this?
|
||||
|
@ -56,7 +56,7 @@
|
||||
<property name="can_focus">True</property>
|
||||
<property name="receives_default">True</property>
|
||||
<property name="action_name">app.show-overlay</property>
|
||||
<property name="text" translatable="yes">Show Numbers on Screens</property>
|
||||
<property name="text" translatable="yes">Overlay Screen Names</property>
|
||||
</object>
|
||||
<packing>
|
||||
<property name="expand">False</property>
|
||||
|
BIN
wdisplays.png
BIN
wdisplays.png
Binary file not shown.
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 43 KiB |
Loading…
Reference in New Issue
Block a user