Skip to content

Commit 5aa48b7

Browse files
committed
Point more clearly to the cibuild script.
Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com>
1 parent 6d3f4e0 commit 5aa48b7

1 file changed

Lines changed: 5 additions & 8 deletions

File tree

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,12 @@ It checks a broad set of points: internal and external links existence (alerting
5959

6060
To install it, It has been incorporated in the Gemfile so the previous dependency install command would have already installed it.
6161

62-
You can run the following gem to tests the generated site.
63-
64-
```bash
65-
bundle exec jekyll build
66-
bundle exec htmlproofer ./_site
67-
```
68-
69-
A utility script has also been included to run these checks in a CI system smoothly.
62+
You can run `bundle exec jekyll build` followed by `bundle exec htmlproofer ./_site` to build and test the generated site.
63+
However, note that a comprehensive configuration is required for the htmlproofer.
64+
Therefore, we strongly suggest to run the utility script at
7065

7166
```bash
7267
./scripts/cibuild
7368
```
69+
70+
which is also used for CI.

0 commit comments

Comments
 (0)