[PATCH v1] rephrasing the index.html to match the current shape of the project

[Bryce Harrington]

On Fri, Nov 27, 2015 at 03:35:11PM +0100, Benoit Gschwind wrote:
> Hello,
> 
> I added bryce comments, my comments and my favorite capitalization.
> 
> Best regards

It's coming along.  Don't forget to take pq's review comments into
account too.  Especially, you need to state the rationale for the change
in your commit message, to explain what the change improves.

> ---
>  index.html | 39 ++++++++++++++++++++++++---------------
>  1 file changed, 24 insertions(+), 15 deletions(-)
> 
> diff --git a/index.html b/index.html
> index a9ebcaa..0788cef 100644
> --- a/index.html
> +++ b/index.html
> @@ -12,21 +12,30 @@
>  
>  <h2>Wayland</h2>
>  
> -<p>Wayland is intended as a simpler replacement for X, easier to develop
> -and maintain.  GNOME and KDE are expected to be ported to it.</p>
> -
> -<p>Wayland is a protocol for a compositor to talk to its clients as
> -well as a C library implementation of that protocol.  The compositor
> -can be a standalone display server running on Linux kernel modesetting
> -and evdev input devices, an X application, or a wayland client itself.
> -The clients can be traditional applications, X servers (rootless or
> -fullscreen) or other display servers.</p>
> -
> -<p>Part of the Wayland project is also the Weston reference
> -implementation of a Wayland compositor.  Weston can run as an X client
> -or under Linux KMS and ships with a few demo clients.  The Weston
> -compositor is a minimal and fast compositor and is suitable for many
> -embedded and mobile use cases.  </p>
> +<p>Wayland intends to replace the X11 protocol. The aim is to be easier
> +to use, improve on the X11 protocol, and perform better.  GNOME and KDE

Perhaps would be worth saying "GNOME, KDE, and Enlightenment" here, if
we're being explicit about DE's, especially since Enlightenment has been
so engaged with Wayland support.

> +are expected to implement this protocol in their own servers.  The
> +Wayland project produces 3 components: <i>wayland</i>, <i>libwayland</i> and
> +<i>weston</i>.</p>
> +
> +<p><i>wayland</i> is a protocol for sharing screens and input devices between
> +concurent clients.  It defines the way servers and clients talks to each
> +other.  The server is reponsible for setting up screens and input
> +devices, and for displaying the final images that the user sees on the
> +screen.  We term this server a 'compositor'.

You need closing </p> tags here and in the next paragraph.

> +<p><i>libwayland</i> is a reference library that implements the Wayland
> +protocol.  This library is intended to help developers implement
> +compositors and clients.  This library is split into a client-side part
> +and a server-side part.
> +
> +<p><i>weston</i> is a reference compositor that use <i>libwayland</i> to talk
> +with its clients.  It can run under Linux's Kernel Mode Setting (KMS) as a
> +stand-alone compositor, or it can run as X client.  In the later case,
> +<i>weston</i> creates a virtual screen that is drawn in an X window and creates
> +virtual input devices taken from the X server; this works similarly to
> +Xnest or Xephyr.  <i>weston</i> also includes a few proof-of-concept clients
> +such as weston-flower, weston-gears, and weston-terminal.</p>

I like how you italicize the introduction of the three terms, and then
italicize the word in each paragraph that defines it.  However I don't
think you should italicize every subsequent reference to the word, so
except for the first <i>weston</i> in this last paragraph, I'd suggest
removing all the other italics.

>  <p>Information:</p>
>  <ul>
> -- 
> 2.4.10
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel

Bryce