update readme

This commit is contained in:
JerryXiao 2023-04-29 12:15:40 +08:00
parent 1666afec4e
commit 6ec6c260d0
Signed by: Jerry
GPG key ID: 22618F758B5BE2E5

View file

@ -5,6 +5,22 @@ A VNC server for DRM/KMS capable GNU/Linux devices.
The goal is to simply have a universally working vncserver on X, wayland and even something like kmscon.
Currently in very early stage.
## Notes
Intel made a great thing called CCS (Color Control Surface), however that won't work with kmsvnc. Please set `INTEL_DEBUG=noccs` globally, ideally in /etc/systemd/system.conf.d. Manpage is at `man 5 systemd-system.conf`. For example:
```
# /etc/systemd/system.conf.d/intel-no-ccs.conf
[Manager]
DefaultEnvironment=INTEL_DEBUG=noccs
```
NixOS:
```
systemd.extraConfig = ''
DefaultEnvironment=INTEL_DEBUG=noccs
''
```
If you plan to use the default vaapi driver for Intel and AMD GPUs, please make sure your vaapi configuration is working.
## Dependencies
* cmake
* libvncserver