diff options
Diffstat (limited to 'documentation/README')
-rw-r--r-- | documentation/README | 14 |
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 | ||
154 | Style checking the Yocto Project documentation | ||
155 | ============================================== | ||
156 | |||
157 | The project is starting to use Vale (https://vale.sh/) | ||
158 | to validate the text style. | ||
159 | |||
160 | To install Vale: | ||
161 | |||
162 | $ pip install vale | ||
163 | |||
164 | To run Vale: | ||
165 | |||
166 | $ make stylecheck | ||
167 | |||
154 | Sphinx theme and CSS customization | 168 | Sphinx theme and CSS customization |
155 | ================================== | 169 | ================================== |
156 | 170 | ||