X-Git-Url: http://git.osdn.net/view?a=blobdiff_plain;f=README;h=d503e533a8a9c444ce6fb6ecd7d15745aaf346fa;hb=8e1d69e285a8d0488fabd802e35bde6e8d3ebdf1;hp=3b2bcbc6c2d59c4c87503bb670a940297c6889ee;hpb=fc0effb8005d2d9654e1e3ec2020fd833f47d6b9;p=luatex-ja%2Fluatexja.git

diff --git a/README b/README
index 3b2bcbc..d503e53 100644
--- a/README
+++ b/README
@@ -1,38 +1,68 @@
-The LuaTeX-ja Package 2012/04/19
+The LuaTeX-ja Package $VER$
 --------------------------------
-Copyright 2011--2012 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.
 This package is highly affected by ASCII pTeX engine, but not a porting of it.
 
 Note that this package is still *alpha-stage*; documentations are not complete
 and specifications are subject to change. Documentations are located at
-  doc/man-en.pdf (en), doc/man-ja.pdf (ja), doc/manual-zh.pdf (zh).
+  doc/luatexja-en.pdf (en), doc/luatexja-ja.pdf (ja).
 
 LuaTeX-ja is developed on
-  <http://sourceforge.jp/projects/luatex-ja/wiki/FrontPage(en)>.
-If you have questions/requests/bugs, please contact the project members via
-links found in the page above. 
-
+  <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 OSDN supplies, via links found in the page above.
 
 
 Installation
 ------------
 
-0. Please make sure that your TeX distribution is up-to-date. 
-   Needed (additional) packages are:
-   - xunicode.sty v0.981
-   - filehook.sty
-1. If you use TeX Live 2011 or later, you can install LuaTeX-ja via tlmgr.
+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.98 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/)
+
+   LuaHBTeX and HarfTeX are not supported for now. With these engines,
+   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 HEAD in the Git repository by
-      <http://git.sourceforge.jp/view?p=luatex-ja/luatexja.git
-                                                    ;a=snapshot;h=HEAD;sf=tgz>
-   b. Extract the archive and put src/ into your TEXMF tree.
+
+   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>
+
+   b. Extract the archive and process following three files by LuaLaTeX
+      to generate classes for Japanese typesetting:
+        src/ltjclasses.ins
+        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.
       An example location is TEXMF/tex/luatex/luatexja.
-   c. Files in src/no_runtime/ are not used in the regular use, 
-      so you can remove them.
-   d. You may need to update the filename database, by 'mktexlsr' or something.
+
+      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).
 
 
 Basic Usage
@@ -41,9 +71,23 @@ Basic Usage
 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.
-- If you want to use the fontspec package, please load luatexja-fontspec.sty.
-  It defines control sequences such as \setmainjfont, setsansjfont and 
-  \jfontspec, which can be used for specifying Japanese fonts.
+- If you want to create Japanese-based documents, you can consider the use of
+  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
+-----
+* This archive contains four .{dtx,ins} pairs:
+    src/ltjclasses.{ins,dtx},  src/ltjltxdoc.{ins,dtx}
+    src/ltjsclasses.{ins,dtx}, doc/luatexja.{ins,dtx}
+  Former three pairs generate class files (see above),
+  while the latter doc/luatexja.{ins,dtx} generates documentations.
+  (You will need Kozuka fonts to regenerate documentaion PDFs.)
+
+  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.
 
+Last commit date: $Format:%cd$