a2684005b6
The README for the IVI-shell is completely outdated. Update the documentation, add some more information on the IVI-shell use cases and explain how to use and customize the IVI-shell. Also convert the file to rst and move it to doc directory next to the kiosk-shell documentation. Signed-off-by: Michael Tretter <m.tretter@pengutronix.de>
37 lines
1.0 KiB
ReStructuredText
37 lines
1.0 KiB
ReStructuredText
Welcome to Weston documentation!
|
|
================================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
toc/running-weston.rst
|
|
toc/libweston.rst
|
|
toc/test-suite.rst
|
|
toc/kiosk-shell.rst
|
|
toc/ivi-shell.rst
|
|
|
|
Weston
|
|
------
|
|
|
|
Weston is the reference implementation of a Wayland compositor, as well as a
|
|
useful environment in and of itself.
|
|
|
|
Out of the box, Weston provides a very basic desktop, or a full-featured
|
|
environment for non-desktop uses such as automotive, embedded, in-flight,
|
|
industrial, kiosks, set-top boxes and TVs. It also provides a library allowing
|
|
other projects to build their own full-featured environments on top of Weston's
|
|
core.
|
|
|
|
The core focus of Weston is correctness and reliability. Weston aims to be lean
|
|
and fast, but more importantly, to be predictable. Whilst Weston does have
|
|
known bugs and shortcomings, we avoid unknown or variable behaviour as much as
|
|
possible, including variable performance such as occasional spikes in frame
|
|
display time.
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`search`
|