From 0d5ce4fb3e61ff909885da3e665c46ad12eef52b Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Tue, 16 Nov 2021 11:03:19 +0100 Subject: [PATCH] readme: advertise the doc website The doc website is currently hidden in the Wayland homepage. Add an explicit link in the README. While at it, rename the section about documentation. "Weston" is already in the repository name and the top oif the README, so no need to repeat here. Signed-off-by: Simon Ser --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8947443d..bbc93b45 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ More [detailed documentation on building Weston](https://wayland.freedesktop.org is available on the Wayland site. There are also more details on [how to run and write tests](https://wayland.freedesktop.org/testing.html). -For building the documentation see [weston-doc](#weston-doc). +For building the documentation see [documentation](#documentation). Running Weston ============== @@ -100,8 +100,11 @@ privileged access to input and output devices by running as root, then granting access to the main Weston binary running as your user. Running Weston this way is not recommended unless necessary. -Weston-doc -========== +Documentation +============= + +To read the Weston documentation online, head over to +[the Weston website](https://wayland.pages.freedesktop.org/weston/). For documenting weston we use [sphinx](http://www.sphinx-doc.org/en/master/) together with [breathe](https://breathe.readthedocs.io/en/latest/) that