OSDN Git Service

README, luatexja.dtx: changed URL to GitHub
[luatex-ja/luatexja.git] / README
diff --git a/README b/README
index 78dbf5e..9d96362 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 The LuaTeX-ja Package $VER$
 --------------------------------
-Copyright (c) 2011--2019 The LuaTeX-ja project
+Copyright (c) 2011--2023 The LuaTeX-ja project
 License: modified BSD (see COPYING)
 
 LuaTeX-ja is a macro package for typesetting Japanese documents with LuaTeX.
@@ -11,10 +11,9 @@ 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
-  <https://osdn.jp/projects/luatex-ja/wiki/FrontPage(en)>.
+  <https://github.com/luatexja/luatexja>.
 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 OSDN supplies, via links found in the page above.
+we would like you to create an issue.
 
 
 Installation
@@ -22,30 +21,28 @@ 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
+    - 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/)
+    - 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
 
    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.
+1. If you are using TeX Live 2021, 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.osdn.jp/view?p=luatex-ja/luatexja.git
-                              ;a=snapshot;h=refs/tags/$VER$;sf=tgz>
+      <https://github.com/luatexja/luatexja/archive/refs/tags/$VER.zip>
 
    b. Extract the archive and process following three files by LuaLaTeX
       to generate classes for Japanese typesetting:
@@ -53,16 +50,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
@@ -91,6 +85,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$