1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
# JUnit 5 User Guide
This subproject contains the AsciiDoc sources for the JUnit 5 User Guide.
## Structure
- `src/docs/asciidoc`: AsciiDoc files
- `src/test/java`: Java test source code that can be included in the AsciiDoc files
- `src/test/kotlin`: Kotlin test source code that can be included in the AsciiDoc files
- `src/test/resources`: Classpath resources that can be included in the AsciiDoc files or
used in tests
## Usage
### Generate AsciiDoc
This following Gradle command generates the HTML version of the User Guide as
`build/docs/asciidoc/user-guide/index.html`.
```
gradlew asciidoctor
```
On Linux operating systems, the `graphviz` package providing `/usr/bin/dot` must be
installed in order to generate the User Guide.
### Generate AsciiDocPdf
This following Gradle command generates the PDF version of the User Guide to
`build/docs/asciidocPdf/user-guide/index.pdf`.
```
gradlew asciidoctorPdf
```
|
