X-Git-Url: http://git.osdn.jp/view?a=blobdiff_plain;f=README;h=f9fb8608563576d394ac75e3a47f3fc7cadd1822;hb=17af71ac2567703411f2aca0fdb0b8050717be90;hp=3b2bcbc6c2d59c4c87503bb670a940297c6889ee;hpb=fc0effb8005d2d9654e1e3ec2020fd833f47d6b9;p=luatex-ja%2Fluatexja.git

diff --git a/README b/README
index 3b2bcbc..f9fb860 100644
--- a/README
+++ b/README
@@ -1,37 +1,59 @@
-The LuaTeX-ja Package 2012/04/19
+The LuaTeX-ja Package $VER$
 --------------------------------
-Copyright 2011--2012 The LuaTeX-ja project
+Copyright (c) 2011--2013 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. 
-
+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.
 
 
 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 beta-0.74.0 or later
+    - luaotfload v2.2
+    - luatexbase v0.6
+    - Several Adobe CMaps 
+      (e.g., UniJIS2004-UTF32-H, Adobe-Japan1-UCS2 for Japanese)
+   Hence this version does not work in TeX Live 2012 (or earlier).
+
+1. If you are using TeX Live 2013 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
+
+   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
-                                                    ;a=snapshot;h=HEAD;sf=tgz>
-   b. Extract the archive and put src/ into your TEXMF tree.
+                              ;a=snapshot;h=refs/tags/$VER$;sf=tgz>
+
+   b1. 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
+
+   b2. Process src/ltj-kinsoku_make.tex by (plain) LuaTeX to generate ltj-kinsoku.lua,
+      which stores default "kinsoku" parameters.
+
+   c. 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.
+
+      If you are updating from old version, you MUST remove it before
+      extracting the new version of LuaTeX-ja.
+
    d. You may need to update the filename database, by 'mktexlsr' or something.
 
 
@@ -41,9 +63,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 
+- 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 
+  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$