Skip to content

Commit

Permalink
Merge pull request #514 from dita-ot/509-readme
Browse files Browse the repository at this point in the history
[#509] Revise instructions for building from dita-ot repo
  • Loading branch information
infotexture authored Nov 10, 2023
2 parents b3bcfba + 35d9219 commit ebb0b5b
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,26 +29,39 @@ You must have a JRE and a local installation of DITA-OT. There is no need to dow
1. Open a command prompt, and change to the directory of your docs repository clone.
2. Type a variant of the following command for your operating system, adjust the path to your DITA-OT installation, and press <kbd>Enter</kbd>:

- On Linux or macOS, use `./gradlew`:
- On **Linux**, **macOS**, or **Git Bash**, use `./gradlew`:

./gradlew -PditaHome=/path/to/dita-ot

- On **Windows**, use `gradlew.bat`:

gradlew.bat -PditaHome=C:\path\to\dita-ot

<details>
<summary>Using a `dita-ot` repository clone</summary>
<details>
<summary><strong>Alternative:</strong> Using a `dita-ot` repository clone</summary>

If you’re using a clone of the [DITA-OT development repository][5] as your toolkit installation alongside your clone of the `docs` repository:

1. In the root directory of your `dita-ot` repository, run Gradle to compile the Java code and install plugins.

- On **Linux**, **macOS**, or **Git Bash**, use `./gradlew`.
- On **Windows**, use `gradlew.bat`.

2. Then run the Gradle build in the `docs` repository to generate topics and build the documentation output.

- If you’re using a clone of the [DITA-OT development repository][5] as your toolkit installation alongside your clone of the docs repository, run the build script on **Linux** or **macOS** like this:
- On **Linux**, **macOS**, or **Git Bash**, run the build script like this:

./gradlew -PditaHome=../dita-ot/src/main
./gradlew -PditaHome=../dita-ot/src/main

- You can also specify a single output format. To build HTML output, enter the following on the command line:
- On **Windows**, use `gradlew.bat`:

gradlew.bat -PditaHome=C:\path\to\dita-ot\src\main

</details>

./gradlew -PditaHome=../dita-ot/src/main html
You can also specify a single output format. To build HTML for example, add `html` to the end of the command:

</details>
./gradlew -PditaHome=/path/to/dita-ot html

### Results

Expand Down Expand Up @@ -125,7 +138,7 @@ If you'd like to check whether your changes are formatted correctly, or format t
[4]: https://www.dita-ot.org
[5]: https://github.com/dita-ot/dita-ot
[6]: https://s3-eu-west-1.amazonaws.com/dita-ot/dita-ot-develop.zip
[7]: https://github.com/dita-ot/dita-ot/blob/develop/build.gradle#L181-L192
[7]: https://github.com/dita-ot/dita-ot/blob/develop/build.gradle#L206-L217
[8]: .github/CONTRIBUTING.md
[9]: https://github.com/dita-ot/docs/wiki/Coding-guidelines
[10]: https://github.com/dita-ot/docs/wiki/Git-workflow#best-practices
Expand Down

0 comments on commit ebb0b5b

Please sign in to comment.