A liberally licensed VNC server library with a clean interface

Go to file

Andri Yngvason 9f67b47e8c damage: Remove vestigial y_inversion code		2019-10-13 10:05:36 +00:00
bench	Tune deflate	2019-10-12 16:42:59 +00:00
contrib/miniz	Add miniz zlib library	2019-08-31 15:27:53 +00:00
examples	Turn around frame update model	2019-10-07 20:29:12 +00:00
include	Excise y-inversion code	2019-10-08 17:58:35 +00:00
src	damage: Remove vestigial y_inversion code	2019-10-13 10:05:36 +00:00
test-images	Add a file to show origin of test images	2019-09-07 16:21:10 +00:00
.gitignore	Clean up Makefile	2019-09-07 13:54:56 +00:00
COPYING	Add license and copyright notices	2019-09-07 16:51:07 +00:00
Makefile	Make nvnc_fb opaque	2019-10-07 17:39:54 +00:00
README.md	README: Fix headers for dependency sections	2019-09-07 19:21:51 +00:00
common.mk	Rename inc -> include for sake of convention	2019-09-14 16:07:34 +00:00
gen-pkgconfig.sh	Create and install pkg-config file	2019-09-07 17:25:27 +00:00
meson.build	meson: Declare dependency for subproject	2019-10-12 15:23:46 +00:00
rfc6143.txt	Add the rfb rfc	2019-08-13 21:42:12 +00:00
test-zrle.c	Create unit test for zrle	2019-08-17 17:12:17 +00:00

README.md

Neat VNC (Beta)

Introduction

This is a liberally licensed VNC server library that's intended to be fast and neat. Note: This is a beta release, so the interface is not yet stable.

Goals

Speed.
Clean interface.
Interoperability with the Freedesktop.org ecosystem.

Building

Runtime Dependencies

pixman
libuv
libpng (only needed for examples and benchmarks)

Build Dependencies

GNU Make
GCC or Clang
pkg-config
libdrm

To build just run:

make

Installing

make install

Variables

CFLAGS: Flags passed to the compiler.
LDFLAGS: Flags passed to the linker.
BUILD_DIR: Destination directory for the build.
PREFIX: System prefix. Default: /usr/local.
DESTDIR: Destination directory for install. This is used by system package system such as dpkg, rpm and pacman.
PKGCONFIG: pkg-config executable path.
STRIP: strip executable path.
DONT_STRIP: Set this is the installed DSO is not to be stripped of its debugging symbols.

Cross-compiling

Generally, it should be enough to set CC=<architecture-triplet>-gcc and then run make, e.g.:

CC=arm-linux-gnueabihf-gcc make

If you have a pkg-config wrapper at <triplet>-pkg-config it will be run instead if pkg-config, but pkg-config can also be overridden by setting the PKGCONFIG environment variable prior to running make.