README.adoc in asciidoctor-2.0.18 vs README.adoc in asciidoctor-2.0.19
- old
+ new
@@ -1,8 +1,8 @@
= Asciidoctor
Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v2.0.18, 2022-10-15
+v2.0.19, 2023-05-17
// settings:
:idprefix:
:idseparator: -
:source-language: ruby
:language: {source-language}
@@ -14,11 +14,11 @@
:note-caption: :paperclip:
:tip-caption: :bulb:
:warning-caption: :warning:
endif::[]
// Variables:
-:release-version: 2.0.17
+:release-version: 2.0.18
// URLs:
:url-org: https://github.com/asciidoctor
:url-repo: {url-org}/asciidoctor
:url-asciidoctorj: {url-org}/asciidoctorj
:url-asciidoctorjs: {url-org}/asciidoctor.js
@@ -128,23 +128,25 @@
== Requirements
Asciidoctor works on Linux, macOS and Windows and requires one of the following implementations of {url-ruby}[Ruby]:
-* CRuby (aka MRI) 2.3 - 3.0
-* JRuby 9.1 - 9.2
+* CRuby (aka MRI) 2.3 - 3.2
+* JRuby 9.1 - 9.4
* TruffleRuby (GraalVM)
[CAUTION]
====
If you're using a non-English Windows environment, you may bump into an `Encoding::UndefinedConversionError` when invoking Asciidoctor.
-To solve this issue, we recommend changing the active code page in your console to UTF-8:
+To solve this issue, we recommend overriding the default external and internal character encodings to `utf-8`.
+You can do so by setting the `RUBYOPT` environment variable as follows:
- chcp 65001
+ RUBYOPT="-E utf-8:utf-8"
-Once you make this change, all your Unicode headaches will be behind you.
+Once you make this change, all your Unicode headaches should be behind you.
+
If you're using an IDE like Eclipse, make sure you set the encoding to UTF-8 there as well.
-Asciidoctor works best when you use UTF-8 everywhere.
+Asciidoctor is optimized to work with UTF-8 as the default encoding.
====
== Installation
Asciidoctor is packaged and distributed to RubyGems.org as a RubyGem (aka gem) named {url-rubygem}[asciidoctor^].