summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorKristian Høgsberg <krh@bitplanet.net>2012-07-20 12:26:23 -0400
committerKristian Høgsberg <krh@bitplanet.net>2012-07-20 12:26:23 -0400
commit72e023cf508c2ab017c4497e50d04631ce654550 (patch)
treecee2260eae740c6eada9a95e7e38f2ccf7c5475b /README
parentd3a1965a3d1e8b40356c2c6fe5f7a40da315b5ff (diff)
downloadweston-72e023cf508c2ab017c4497e50d04631ce654550.tar.gz
Flesh out README a bit, link to building instructions
Diffstat (limited to 'README')
-rw-r--r--README19
1 files 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.