From 72e023cf508c2ab017c4497e50d04631ce654550 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kristian=20H=C3=B8gsberg?= Date: Fri, 20 Jul 2012 12:26:23 -0400 Subject: [PATCH] Flesh out README a bit, link to building instructions --- README | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README b/README index 9cb3ef64..b3be4c99 100644 --- a/README +++ b/README @@ -1,6 +1,15 @@ -Wayland Demos +Weston -This repository contains a few demos application for the Wayland -project. There's a sample compositor that can run on KMS, under X11 -or under another Wayland compositor and there's a handful of simple -clients that demonstrate various aspects of Wayland: +Weston is the reference implementation of a Wayland compositor, and a +useful compositor in its own right. Weston has various backends that +lets it run on Linux kernel modesetting and evdev input as well as +under X11. Weston ships with a few example clients, from simple +clients that demonstrate certain aspects of the protocol to more +complete clients and a simplistic toolkit. There is also a quite +capable terminal emulator (weston-terminal) and an toy/example desktop +shell. Finally, weston also provides integration with the Xorg server +and can pull X clients into the Wayland desktop and act as a X window +manager. + +Refer to http://wayland.freedesktop.org/building.html for buiding +weston and its dependencies.