trailed whitespace at the end of a line

[luatex-ja/luatexja.git] / README

diff --git a/README b/README
index e1d0392..7a22492 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 The LuaTeX-ja Package $VER$
 --------------------------------
 The LuaTeX-ja Package $VER$
 --------------------------------

-Copyright (c) 2011--2013 The LuaTeX-ja project
+Copyright (c) 2011--2014 The LuaTeX-ja project

 License: modified BSD (see COPYING)
 
 LuaTeX-ja is a macro package for typesetting Japanese documents with LuaTeX.
 License: modified BSD (see COPYING)
 
 LuaTeX-ja is a macro package for typesetting Japanese documents with LuaTeX.


@@ -8,7 +8,7 @@ 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
 
 Note that this package is still *alpha-stage*; documentations are not complete
 and specifications are subject to change. Documentations are located at

-  doc/luatexja-en.pdf (en), doc/luatexja-ja.pdf (ja), doc/luatexja-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)>.
 
 LuaTeX-ja is developed on
   <http://sourceforge.jp/projects/luatex-ja/wiki/FrontPage(en)>.


@@ -37,13 +37,22 @@ Installation
       <http://git.sourceforge.jp/view?p=luatex-ja/luatexja.git
                               ;a=snapshot;h=refs/tags/$VER$;sf=tgz>
 
       <http://git.sourceforge.jp/view?p=luatex-ja/luatexja.git
                               ;a=snapshot;h=refs/tags/$VER$;sf=tgz>
 

-   b. Extract the archive and put src/ into your TEXMF tree.
+   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.
 
       If you are updating from old version, you MUST remove it before
       extracting the new version of LuaTeX-ja.
 
       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.
 

-   c. You may need to update the filename database, by 'mktexlsr' or something.
+   d. You may need to update the filename database, by 'mktexlsr' or something.

 
 
 Basic Usage
 
 
 Basic Usage


@@ -58,5 +67,17 @@ Simply loading luatexja.sty by \input or \usepackage does the minimal setting.
   It defines control sequences such as \setmainjfont, setsansjfont and
   \jfontspec, which can be used for specifying Japanese fonts.
 
   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$
 
 Last commit date: $Format:%cd$