Commit graph

16 commits

Author SHA1 Message Date
Simon Ser
733de76221 Convert plaintext documents to Markdown
This converts GOVERNANCE, MEMBERS and README to Markdown documents.
These are only cosmetic changes, the actual contents and wording have
been retained.

GitLab pretty-prints Markdown and adds anchors. We can now add links
from one document to another.

Unfortunately GOVERNANCE lettered lists have been converted to numbered
lists, because Markdown doesn't support the former.

Signed-off-by: Simon Ser <contact@emersion.fr>
Closes: https://gitlab.freedesktop.org/wayland/wayland-protocols/issues/3
2019-12-18 17:42:23 +00:00
Simon Ser
6d0fc70656
readme: changes should be submitted via GitLab
510188250e ("Add governance document") adds a GOVERNANCE document
describing development based on GitLab merge requests. Update the README
file accordingly.

Some information is duplicated across README and GOVERNANCE, this is
intentional to make README provide a more human-friendly, less
bureaucratic version. GOVERNANCE is still the authoritative version.

Signed-off-by: Simon Ser <contact@emersion.fr>
2019-11-21 13:47:56 +01:00
Yong Bakos
a50668559c readme: Correct spelling and grammar
Signed-off-by: Yong Bakos <ybakos@humanoriented.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
2016-04-13 12:35:00 -07:00
Jonas Ådahl
7c671d7967 README: postfix -> suffix
Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2015-11-17 15:31:43 +08:00
Jonas Ådahl
f4346218f2 README: Use the word 'deprecated' instead of 'obsolete'
Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2015-11-17 15:31:43 +08:00
Jonas Ådahl
98ccc10879 README: Add note about CC:ing maintainers
Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2015-11-16 16:51:53 +08:00
Jonas Ådahl
f7d16f7983 README: Make the interface major version suffix more clear
Append _vN instead of just N where N is the major version.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2015-11-09 15:04:24 +08:00
Jonas Ådahl
a01435ea22 README: Some clarifications regarding major vs minor versions
Was missing that the major version is also part of the interface names.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2015-11-09 15:04:24 +08:00
Jonas Ådahl
a3023a86ab README: Document interface naming convention
Document that what different types of protocols should prefix their
interfaces with.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2015-11-09 15:04:24 +08:00
Jonas Ådahl
0c7973d72b README: Change the examples from wl_ to wp_
It was decided that the wl_ prefixed used by protocols and the
wayland-client and wayland-server API should only be used by those two
libraries.

Instead, invent a new prefix for protocols in wayland-protocols: wp_,
which stands for Wayland Protocol.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2015-11-09 15:04:24 +08:00
Jonas Ådahl
53fcfe3eba README: Remove confusing part of paragraph about releases
It should be understood that it is possible to make "oops didn't mean
that" commits making intra-release backward incompatible changes.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2015-11-09 15:04:07 +08:00
Jonas Ådahl
2400377661 README: Another typo fix and some line wrap cleanup
Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2015-11-06 12:16:31 +08:00
Pekka Paalanen
2f06d21c60 README: typo fixes
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Jonas Ådahl <jadahl@gmail.com>
2015-11-06 12:16:09 +08:00
Jonas Ådahl
0030020eb8 README: Clarify unstable between release on an unstable protocol
Unstable changes can be made to unstable protocols, but this was about
unstable changes within the same major version.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2015-11-03 12:06:32 +08:00
Jonas Ådahl
3636478a8d Added README file describing development procedures etc
The format used is (unverified) AsciiDoc.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2015-11-03 11:50:55 +08:00
Jonas Ådahl
7b966956f7 Initial commit
Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2015-10-09 11:33:49 +08:00