• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1Welcome to Weston documentation!
2================================
3
4.. toctree::
5   :maxdepth: 2
6   :caption: Contents:
7
8   toc/libweston.rst
9   toc/test-suite.rst
10   toc/kiosk-shell.rst
11
12Weston
13------
14
15Weston is the reference implementation of a Wayland compositor, as well as a
16useful environment in and of itself.
17
18Out of the box, Weston provides a very basic desktop, or a full-featured
19environment for non-desktop uses such as automotive, embedded, in-flight,
20industrial, kiosks, set-top boxes and TVs. It also provides a library allowing
21other projects to build their own full-featured environments on top of Weston's
22core.
23
24The core focus of Weston is correctness and reliability. Weston aims to be lean
25and fast, but more importantly, to be predictable. Whilst Weston does have
26known bugs and shortcomings, we avoid unknown or variable behaviour as much as
27possible, including variable performance such as occasional spikes in frame
28display time.
29
30Indices and tables
31==================
32
33* :ref:`genindex`
34* :ref:`search`
35