Merge branch 'kitagawa_test' into kitagawa_nfss

[luatex-ja/luatexja.git] / README

diff --git a/README b/README
index ee3d3d3..78dbf5e 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 The LuaTeX-ja Package $VER$
 --------------------------------
-Copyright (c) 2011--2015 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.
@@ -11,11 +11,10 @@ and specifications are subject to change. Documentations are located at
   doc/luatexja-en.pdf (en), doc/luatexja-ja.pdf (ja).
 
 LuaTeX-ja is developed on
-  <http://sourceforge.jp/projects/luatex-ja/wiki/FrontPage(en)>.
+  <https://osdn.jp/projects/luatex-ja/wiki/FrontPage(en)>.
 If you have questions or recognize bugs/have feature requests,
 we would like you to create a thread in the forum or a ticket
-in the way which SourceForge.JP supplies, via links found in
-the page above.
+in the way which OSDN supplies, via links found in the page above.
 
 
 Installation
@@ -23,20 +22,29 @@ Installation
 
 0. Please make sure that your TeX distribution is up-to-date.
    This version of LuaTeX-ja requires
-    - LuaTeX beta-0.80.0 or later
-    - luaotfload v2.5
+    - LuaTeX 1.0.0 or later
+    - luaotfload (v3.1 or later recommended)
     - adobemapping (Adobe CMap files)
     - everysel package
+    - 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 2014 (or earlier).
 
-1. If you are using TeX Live 2015 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:
 
    a. Download the source archive from CTAN,
       or tagged as $VER$ in the Git repository by
-      <http://git.sourceforge.jp/view?p=luatex-ja/luatexja.git
+      <http://git.osdn.jp/view?p=luatex-ja/luatexja.git
                               ;a=snapshot;h=refs/tags/$VER$;sf=tgz>
 
    b. Extract the archive and process following three files by LuaLaTeX
@@ -64,13 +72,16 @@ LuaTeX-ja supports both the plain format and LaTeX2e.
 Simply loading luatexja.sty by \input or \usepackage does the minimal setting.
 
 - If you want to create Japanese-based documents, you can consider the use of
-  ltj{article,book,report}.cls or ltjs{article,book}.cls.
+  ltj{article,book,report}.cls or ltjs{article,book,report}.cls.
 - If you want to use functionality of the fontspec package with Japanese fonts,
   load luatexja-fontspec.sty. It defines control sequences such as \setmainjfont,
   \setsansjfont and  \jfontspec, which can be used for specifying Japanese fonts.
 
 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}