diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2021-07-18 23:59:25 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2021-07-19 01:15:28 -0600 |
| commit | 50f0c7c7320957cc0d170f5e3f5918a339fb1ac2 (patch) | |
| tree | 25d16f479a4a4dd639b08934056d12fbb0dd9e2d /docs/modules/cli | |
| parent | dc2f13a70f27eb7f9fc4ca14dc822f784aa3920c (diff) | |
clarify wording on CLI docs page [skip ci]
Diffstat (limited to 'docs/modules/cli')
| -rw-r--r-- | docs/modules/cli/pages/index.adoc | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/modules/cli/pages/index.adoc b/docs/modules/cli/pages/index.adoc index 876d61ec..ac6af138 100644 --- a/docs/modules/cli/pages/index.adoc +++ b/docs/modules/cli/pages/index.adoc @@ -7,18 +7,18 @@ Command line usage quick start for Asciidoctor included in the install-toolchain and user-manual documents //// -When the Asciidoctor gem is installed successfully, the Asciidoctor command line interface (CLI) will be available on your PATH. -To confirm that Asciidoctor is available, execute: +When the Asciidoctor gem is installed successfully, the Asciidoctor command line interface (CLI) named `asciidoctor` will be available on your PATH. +To confirm that the CLI is available, execute the following command in your terminal application: $ asciidoctor --version -The following information should be output in your terminal: +If this command completes successfully, information about Asciidoctor and the runtime environment will be printed to the standard output of your terminal: [subs=attributes+] Asciidoctor {release-version} [https://asciidoctor.org] Runtime Environment ({ruby-description}) (lc:UTF-8 fs:UTF-8 in:UTF-8 ex:UTF-8) -The runtime environment information will vary based on the version of Ruby you are using and the encoding settings of your operating system. +The runtime environment information varies based on the version of Ruby you're using and the encoding settings of your operating system. To invoke Asciidoctor from the CLI and convert an `.adoc` file, execute: |