summaryrefslogtreecommitdiffstats
path: root/documentation/README
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/README')
-rw-r--r--documentation/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/documentation/README b/documentation/README
index 4d31036e69..8035418cac 100644
--- a/documentation/README
+++ b/documentation/README
@@ -151,6 +151,20 @@ dependencies in a virtual environment:
151 $ pipenv install 151 $ pipenv install
152 $ pipenv run make html 152 $ pipenv run make html
153 153
154Style checking the Yocto Project documentation
155==============================================
156
157The project is starting to use Vale (https://vale.sh/)
158to validate the text style.
159
160To install Vale:
161
162 $ pip install vale
163
164To run Vale:
165
166 $ make stylecheck
167
154Sphinx theme and CSS customization 168Sphinx theme and CSS customization
155================================== 169==================================
156 170