README.adoc in asciidoctor-reducer-1.0.0.alpha.5 vs README.adoc in asciidoctor-reducer-1.0.0.alpha.6

- old
+ new

@@ -1,8 +1,8 @@ = {project-name} Dan Allen <https://github.com/mojavelinux[@mojavelinux]> -v1.0.0.alpha.5, 2022-02-06 +v1.0.0.alpha.6, 2022-02-10 :idprefix: :idseparator: - ifndef::env-github[:icons: font] ifdef::env-github[] :caution-caption: :fire: @@ -21,18 +21,18 @@ If the document does not contain any preprocessor directives, the tool returns the original source. == Prerequisites {project-name} is a Ruby program that you install using Ruby packaging. -Therefore, to install and run {project-name}, you need Ruby 2.5 or better installed. +To install and run {project-name}, you need Ruby 2.5 or better. -To check whether you have Ruby installed, and which version, run the following command: +Run the following command to check whether you have Ruby installed and to check which version: $ ruby -v If Ruby is not installed, you can install it using {url-rvm}[RVM] (or, if you prefer, the package manager for your system). -We generally recommend using RVM because it allows you to install gems without requiring elevated privileges or messing with system libraries. +We generally recommend using RVM as it allows you to install gems without requiring elevated privileges or messing with system libraries. == Installation {project-name} is published to RubyGems.org as the gem named *{project-handle}*. @@ -73,12 +73,14 @@ .... asciidoctor-reducer [OPTION]... FILE .... The argument `FILE` is the AsciiDoc file you want to reduce. -To use the command, pass the AsciiDoc file as the sole argument: +The options, represented by `[OPTION]...`, are optional, as the name suggestions. +Thus, to use the command, pass the AsciiDoc file as the sole argument: + $ asciidoctor-reducer input.adoc By default, the command will output the reduced AsciiDoc document to the terminal (via stdout). To write the output to a file, specify an output file using the `-o` option: @@ -232,10 +234,10 @@ When running the `asciidoctor-reducer` command from source, you must prefix the command with `bundle exec`: [subs=attributes+] $ bundle exec asciidoctor-reducer sample.adoc -To avoid having to do this, or make the `asciidoctor-reducer` command available from anywhere, you need to build the development gem and install it. +To avoid having to do this, or to make the `asciidoctor-reducer` command available from anywhere, you need to build the development gem and install it. == Copyright and License Copyright (C) 2021-present Dan Allen. Use of this software is granted under the terms of the MIT License.