[PATCH weston 3/5] README: Move to Markdown, rewrite introduction

[Daniel Stone]

Hi Pekka,

On Tue, 7 Aug 2018 at 14:25, Pekka Paalanen <ppaalanen at gmail.com> wrote:
> On Mon,  6 Aug 2018 12:09:22 +0100 Daniel Stone <daniels at collabora.com> wrote:
> > Move the README file to Markdown, and update it to attempt to explain
> > the current status and use of Weston.
> >
> > The first sections are user-facing, so they can quickly understand what
> > Weston is, what it does, what it doesn't do, and how to go about using
> > it. The following sections on libweston and for distribution packagers
> > are left intact, but should probably be moved to separate documents.
>
> Hi,
>
> here could be a note about where the screenshot is from, so one could
> track it's author and copyright if necessary, or at least keep it not
> any more vague than it already was.

Good point! Fixed.

> > +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.
>
> A thought: should we have some words about how weston aims for
> production quality for non-desktop use cases? I think that is what the
> above paragraph is trying to say.

Yeah, that would be great; suggestions welcome!

> > +Every commit of Weston is built using GitLab CI.
> > +[Reading the configuration](.gitlab-ci.yml) may provide a useful example of how
> > +to build and install Weston.
>
> Btw. do we actually have it building every commit rather than every push?

Ah, no. Wording fixed.

> Anyway, this patch is:
>
> Reviewed-by: Pekka Paalanen <pekka.paalanen at collabora.co.uk>

Thankyou, pushed now! I'm now never using git-send-email for Weston again. \o/

Cheers,
Daniel