A liberally licensed VNC server library with a clean interface
 
 
 
Go to file
Andri Yngvason 8026f11b80 README: Document dependencies 2019-09-07 19:18:57 +00:00
bench bench: zrle: Use memcpy as a baseline 2019-09-07 18:38:32 +00:00
contrib/miniz Add miniz zlib library 2019-08-31 15:27:53 +00:00
examples Add license and copyright notices 2019-09-07 16:51:07 +00:00
inc Remove unused code 2019-09-07 18:42:55 +00:00
src Explain what pngfb.c does 2019-09-07 18:44:48 +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 Use target specific pkg-config wrapper if available 2019-09-07 17:30:21 +00:00
README.md README: Document dependencies 2019-09-07 19:18:57 +00:00
common.mk Allow over-riding of strip exec 2019-09-07 17:31:20 +00:00
gen-pkgconfig.sh Create and install pkg-config file 2019-09-07 17:25:27 +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

Introduction

This is a liberally licensed VNC server library that's intended to be fast and neat.

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.