Target release date: 2022-07-02

[luatex-ja/luatexja.git] / README

diff --git a/README b/README
index 5c4c3e3..b3d962e 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--2022 The LuaTeX-ja project
 License: modified BSD (see COPYING)
 
 LuaTeX-ja is a macro package for typesetting Japanese documents with LuaTeX.
@@ -22,20 +22,22 @@ Installation
 
 0. Please make sure that your TeX distribution is up-to-date.
    This version of LuaTeX-ja requires
-    - LuaTeX beta-0.85.0 or later
-    - luaotfload v2.6
+    - LuaTeX 1.10.0 (or later)
+    - luaotfload (v3.1 or later recommended)
     - adobemapping (Adobe CMap files)
-    - everysel package
+    - LaTeX2e 2020-02-02 patch level 5 or later (if you want to use with LaTeX)
     - etoolbox package
-    - ltxcmds package
-    - pdftexcmds package
-    - atbegshi package
-    - filehook package
-    - stfloats package
-    - IPAex fonts (http://ipafont.ipa.go.jp/)
-   Hence this version does not work in TeX Live 2015 (or earlier).
+    - ltxcmds package, pdftexcmds package
+    - filehook package, atbegshi package (for LaTeX2e 2020-02-02)
+    - everysel package (for LaTeXe 2020-02-02 and 2020-10-01)
+    - Harano Aji fonts (https://github.com/trueroad/HaranoAjiFonts)
+         more specifically, HaranoAjiMincho-Regular and HaranoAjiGothic-Medium
 
-1. If you are using TeX Live 2016 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 2021, you can install LuaTeX-ja via tlmgr.
 
 2. If you must/want to install manually:
 
@@ -50,16 +52,13 @@ Installation
         src/ltjltxdoc.ins
         src/ltjsclasses.ins
 
-   c. Process src/ltj-kinsoku_make.tex by (plain) LuaTeX to generate ltj-kinsoku.lua,
-      which stores default "kinsoku" parameters.
-
-   d. Put src/ into your TEXMF tree.
+   c. Put src/ into your TEXMF tree.
       An example location is TEXMF/tex/luatex/luatexja.
 
       If you are updating from old version, you MUST remove it before
       extracting the new version of LuaTeX-ja.
 
-   e. You may need to update the filename database, by mktexlsr (or by another program).
+   d. You may need to update the filename database, by mktexlsr (or by another program).
 
 
 Basic Usage
@@ -76,6 +75,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}
@@ -85,6 +87,10 @@ Notes
 
   No .{dtx,ins} pair generates .sty files of LuaTeX-ja package.
 
-* src/*.{ins.dtx} and src/ltj-kinsoku_make.tex are not needed in regular use.
+* src/*.{ins.dtx} are not needed in regular use.
+
+* ltj-kinsoku_make.tex is removed in version 20200808.0.
+  This file and ltj-kinsoku.lua are not used anymore.
+  (Do not remove ltj-kinsoku.tex.)
 
 Last commit date: $Format:%cd$