diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2023-04-09 15:41:39 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2023-04-09 15:41:39 -0600 |
| commit | 1faf5d7ab1a2c3c18b3df7fb115ec9a942de3422 (patch) | |
| tree | ead09ddc09482901f01ff130d353c8b93638e378 | |
| parent | cdca80cbfce3894b30669f8a4c0598cb065df889 (diff) | |
clarify prerequisites section in documentation
| -rw-r--r-- | docs/modules/ROOT/pages/install.adoc | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/modules/ROOT/pages/install.adoc b/docs/modules/ROOT/pages/install.adoc index 2aa970b6..a89fabef 100644 --- a/docs/modules/ROOT/pages/install.adoc +++ b/docs/modules/ROOT/pages/install.adoc @@ -11,9 +11,12 @@ You can also find some troubleshooting advice if the installation goes wrong. Asciidoctor PDF is a Ruby application. Therefore, to use it, you'll need a Ruby runtime. -The supported Ruby runtimes are Ruby 2.7 or greater and JRuby 9.2 or greater. -However, we always recommend using the most recent release of Ruby or JRuby. -All required libraries (i.e., gems) will be installed automatically when you install Asciidoctor PDF, which will be covered in the <<Install Asciidoctor PDF,next section>>. +The Ruby versions on which Asciidoctor PDF is supported {url-project-repo}/blob/{page-origin-refname}/.github/workflows/ci.yml[and tested] are Ruby 2.7 or greater or JRuby 9.2 or greater. +We always recommend using the most recent version of Ruby or JRuby, if possible. +If you attempt to use an unsupported version of Ruby with Asciidoctor PDF, the conversion will likely fail in unexpected ways. + +All required libraries (i.e., gems) will be installed automatically when you install Asciidoctor PDF, which is covered in the <<Install Asciidoctor PDF,next section>>. +You must install any <<optional-dependencies,optional dependencies>> yourself in order to activate the corresponding optional features. To check if you have Ruby available, run the `ruby` command to print the installed version: |