Skip to content

Commit bc1d65d

Browse files
committed
Polishing
1 parent 823a506 commit bc1d65d

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

documentation/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,21 @@ This subproject contains the AsciiDoc sources for the JUnit 5 User Guide.
55
## Structure
66

77
- `src/docs/asciidoc`: AsciiDoc files
8-
- `src/test/java`: Test source code that can be included in the AsciiDoc files
9-
- `src/main/java`: Example source code that can be included in the AsciiDoc files
8+
- `src/test/java`: Java test source code that can be included in the AsciiDoc files
9+
- `src/test/kotlin`: Kotlin test source code that can be included in the AsciiDoc files
10+
- `src/test/resources`: Classpath resources that can be included in the AsciiDoc files or
11+
used in tests
1012

1113
## Usage
1214

1315
### Generate AsciiDoc
1416

15-
On linux, `graphviz` package providing `/usr/bin/dot` needs to be installed.
17+
This following Gradle command generates the HTML version of the User Guide as
18+
`build/asciidoc/index.html`.
1619

1720
```
18-
gradle asciidoctor
21+
gradlew asciidoctor
1922
```
2023

21-
This task generates HTML files into `build/asciidoc`.
24+
On Linux operating systems, the `graphviz` package providing `/usr/bin/dot` must be
25+
installed in order to generate the User Guide.

0 commit comments

Comments
 (0)