summaryrefslogtreecommitdiff
path: root/poky/documentation/README
diff options
context:
space:
mode:
Diffstat (limited to 'poky/documentation/README')
-rw-r--r--poky/documentation/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/poky/documentation/README b/poky/documentation/README
index 4d31036e69..8035418cac 100644
--- a/poky/documentation/README
+++ b/poky/documentation/README
@@ -151,6 +151,20 @@ dependencies in a virtual environment:
$ pipenv install
$ pipenv run make html
+Style checking the Yocto Project documentation
+==============================================
+
+The project is starting to use Vale (https://vale.sh/)
+to validate the text style.
+
+To install Vale:
+
+ $ pip install vale
+
+To run Vale:
+
+ $ make stylecheck
+
Sphinx theme and CSS customization
==================================