Commit Graph

20 Commits

Author SHA1 Message Date
Emil Velikov
2eda27b7fb
README: fix s/libwayland/libweston/ typo
Since one is (about to be) using libweston, they should check for it as
opposed to libwayland.

Silly copy/paste mistake that would have caused a lot of confusion.

Signed-off-by: Emil Velikov <emil.velikov@collabora.com>
Reviewed-by: Quentin Glidic <sardemff7+git@sardemff7.net>
2016-08-15 18:06:46 +02:00
Pekka Paalanen
72416979cb README: updates on libweston versioning
We have agreed to use the major as the ABI-version, so talk about major
to avoid confusion.

Remove unncessary or incorrect wording related to breaking ABI on minor
bumps.

Explain a little about the weston vs. libweston version numbers.

v2:
- Add a paragraph about ABI breaks between alpha and .0 releases.
- clarify pre-release definition
- Add two paragraphs about libweston versions differing from weston
  version and how to use pkg-config properly.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Quentin Glidic <sardemff7+git@sardemff7.net>
Reviewed-by: Jonas Ådahl <jadahl@gmail.com>
Reviewed-by: Emil Velikov <emil.velikov@collabora.com>
2016-08-15 18:07:06 +03:00
Emil Velikov
aa485921cf README: Document versioning scheme, forward compatibility
Signed-off-by: Emil Velikov <emil.velikov@collabora.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Quentin Glidic <sardemff7+git@sardemff7.net>
2016-08-02 13:52:09 +03:00
Bryce Harrington
e4cb3c2ce2 README: Fix grammar for 'an X*' 2016-07-07 10:53:17 -07:00
Bryce Harrington
585eef3437 README: Fix punctuation errors
Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>
2016-07-06 14:50:38 -07:00
Emil Velikov
2d01e9138e README: minor the libweston ABI/API documentation
v2: Elaborate what is meant with "major ABI versions" (Pekka).

Signed-off-by: Emil Velikov <emil.velikov@collabora.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk> (v1)
2016-07-05 18:00:31 +03:00
Emil Velikov
99ac6232fa README: clarify libweston purpose/goals.
v2: Rewrap, add a couple of missing words (Pekka).
v3: Use alternative wording (Yong).

Signed-off-by: Emil Velikov <emil.velikov@collabora.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2016-07-05 18:00:17 +03:00
Pekka Paalanen
58f98c99f5 Move weston source to compositor/
This is the start of separating weston-the-compositor source files from
libweston source files.

This is moving all the files related to the 'weston' binary. Also the
CMS and systemd plugins are moved.

xwayland plugin is not moved, because it will be turned into a
libweston feature.

To avoid breaking the build, #includes for weston.h are fixed to use
compositor/weston.h. This serves as a reminder that such files may need
further attention: moving to the right directory, or maybe using the
proper -I flags instead.

v2: Move also screen-share.c, and add a note about weston-launch.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Yong Bakos <ybakos@humanoriented.com>
Acked-by: Daniel Stone <daniels@collabora.com>
Reviewed-by: Quentin Glidic <sardemff7+git@sardemff7.net>
Tested-by: Quentin Glidic <sardemff7+git@sardemff7.net>
Tested-by: Benoit Gschwind <gschwind@gnu-log.net>
Acked-by: Benoit Gschwind <gschwind@gnu-log.net>
[Pekka: rebased]
2016-06-23 17:44:54 +03:00
Pekka Paalanen
ca52b31d3f Remove Raspberry Pi backend and renderer
This patch completely removes the Raspberry Pi backend and the renderer.

The backend and the renderer were written to use the proprietary
DispmanX API available only on the Raspberry Pi, to demonstrate what the
tiny computer is capable of graphics wise. They were also used to
demonstrate how Wayland and Weston in particular could leverage hardware
compositing capabilities that are not OpenGL. The backend was first
added in e8de35c922, in 2012.

Since then, the major point has been proven. Over time, support for the
rpi-backend diminished, it started to deteriorate and hinder Weston
development. On May 11, I tried to ask if anyone actually cared about
the rpi-backend, but did not get any votes for keeping it:
https://lists.freedesktop.org/archives/wayland-devel/2016-May/028764.html

The rpi-backend is a good example of how using an API that is only
available for specific hardware, even more so as it is only available
with a proprietary driver stack, is not maintainable in the long run.
Most developers working on Weston either just cannot, or cannot bother
to test things also on the RPi. Breakage creeps in without anyone
noticing. If someone actually notices it, fixing it will require a very
specific environment to be able to test. Also the quality of the
proprietary implementation fluctuated. There are reports that RPi
firmware updates randomly broke Weston, and that nowadays it is very
hard to find a RPi firmware version that you could expect to work with
Weston if Weston itself was not broken. We are not even sure what is
broken nowadays.

This removal does not leave Raspberry Pi users cold (for long), though.
There is serious work going on in implementing a FOSS driver stack for
Raspberry Pi, including modern kernel DRM drivers and Mesa drivers. It
might not be fully there yet, but the plan is to be able to use the
standard DRM-backend of Weston on the RPis. See:
http://dri.freedesktop.org/wiki/VC4/

The rpi-backend had its moments. Now, it needs to go. Good riddance!

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Derek Foreman <derekf@osg.samsung.com>
Acked-by: Bryce Harrington <bryce@osg.samsung.com>
Acked-by: Jonas Ådahl <jadahl@gmail.com>
Acked-by: Daniel Stone <daniels@collabora.com>
2016-06-03 10:23:52 +03:00
Jon A. Cruz
179c186e19 Adding doxygen setup and info for the testing framework.
Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2015-07-17 13:28:02 +03:00
Pekka Paalanen
2abe445546 README: introduce libweston
What is libweston and where do we intend to go with it.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
Acked-by: Giulio Camuffo <giuliocamuffo@gmail.com>
Acked-by: Daniel Stone <daniels@collabora.com>
Acked-by: Jon A. Cruz <jonc@osg.samsung.com>
2015-07-16 12:40:02 +03:00
Bryce W. Harrington
c74ab15eac README: Fix typo; add link to testing docs
Signed-off-by: Bryce Harrington <b.harrington@samsung.com>
2014-02-05 17:20:24 -08:00
Kristian Høgsberg
72e023cf50 Flesh out README a bit, link to building instructions 2012-07-20 12:26:23 -04:00
Kristian Høgsberg
b2d71852fd Split into a demo repository that holds the demo compositor and clients 2011-02-14 22:13:33 -05:00
Peter Hutterer
b97b28c339 README: fix a few typos
And one in the main.tex spec document.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2010-11-10 08:42:17 -05:00
Nikolai Kondrashov
6048e8d9f6 Fix Wayland build instructions
Replace aclocal; autoconf invocation in Wayland build instructions with
an up-to-date ./autogen.sh invocation.

Signed-off-by: Nikolai Kondrashov <spbnick@gmail.com>
2010-11-08 08:55:17 -05:00
Kristian Høgsberg
a6f6999e49 Consolidate NOTES and README 2010-09-14 12:41:59 -04:00
Kristian Høgsberg
a46dc06da7 Copy over updated build instructions from the google group 2010-09-14 12:41:59 -04:00
Kristian Høgsberg
61ba898b73 README: Add link to google group. 2008-11-06 10:53:03 -05:00
Kristian Høgsberg
33a52bd07d Add README for the adventurous, allow evdev override from getenv(). 2008-11-06 10:53:02 -05:00