Merge branch 'kitagawa_test' into kitagawa_nfss

[luatex-ja/luatexja.git] / README

diff --git a/README b/README
index 94e2120..78dbf5e 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 The LuaTeX-ja Package $VER$
 --------------------------------
-Copyright (c) 2011--2018 The LuaTeX-ja project
+Copyright (c) 2011--2019 The LuaTeX-ja project
 License: modified BSD (see COPYING)
 
 LuaTeX-ja is a macro package for typesetting Japanese documents with LuaTeX.
@@ -23,7 +23,7 @@ Installation
 0. Please make sure that your TeX distribution is up-to-date.
    This version of LuaTeX-ja requires
     - LuaTeX 1.0.0 or later
-    - luaotfload v2.6
+    - luaotfload (v3.1 or later recommended)
     - adobemapping (Adobe CMap files)
     - everysel package
     - etoolbox package
@@ -33,9 +33,12 @@ Installation
     - filehook package
     - stfloats package
     - IPAex fonts (http://ipafont.ipa.go.jp/)
-   Hence this version does not work in TeX Live 2016 (or earlier).
 
-1. If you are using TeX Live 2018 or later, you can install LuaTeX-ja via tlmgr.
+   Using LuaTeX-ja with LuaHBTeX is not well tested.
+   One might be able to typeset documents without an error, but with
+   some unwanted results.
+
+1. If you are using TeX Live 2019 or later, you can install LuaTeX-ja via tlmgr.
 
 2. If you must/want to install manually:
 
@@ -76,6 +79,9 @@ Simply loading luatexja.sty by \input or \usepackage does the minimal setting.
 
 Notes
 -----
+* We don't recommend defining a Japanese font with HarfBuzz, by specifying
+  "Renderer=..." (fontspec) or "mode=harf" (otherwise).
+
 * This archive contains four .{dtx,ins} pairs:
     src/ltjclasses.{ins,dtx},  src/ltjltxdoc.{ins,dtx}
     src/ltjsclasses.{ins,dtx}, doc/luatexja.{ins,dtx}