README: Improve introduction

vencrypt
Andri Yngvason 2020-01-17 07:58:16 +00:00
parent e2079a7e56
commit 3c76c33835
1 changed files with 4 additions and 1 deletions

View File

@ -1,7 +1,10 @@
# wayvnc
## Introduction
This is a VNC server for wlroots based Wayland compositors.
This is a VNC server for wlroots based Wayland compositors. It attaches to a
running Wayland session, creates virtual input devices and exposes a single
display via the RFB protocol. The Wayland session may be a headless one, so it
is also possible to run wayvnc without a physical display attached.
## Building
### Runtime Dependencies