trailed whitespace at the end of a line

[luatex-ja/luatexja.git] / README

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

 --------------------------------
 --------------------------------

-Copyright (c) 2011--2012 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,35 +8,51 @@ 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)>.

-If you recognise questions/requests or bugs, we would like you to make a
-thread in the forum or a ticket in the bug tracking system for that in the way
-which SourceForge.jp supplies, 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.
 
 
 Installation
 ------------
 
 0. Please make sure that your TeX distribution is up-to-date.

-   LuaTeX-ja (luatexja-fontspec.sty) requires xunicode.sty v0.981.
+   This version of LuaTeX-ja requires 
+    - LuaTeX beta-0.74.0 or later
+    - luaotfload v2.2
+    - luatexbase v0.6
+   Hence this version does not work in TeX Live 2012 (or earlier).

 
 

-1. If you use TeX Live 2011 or later, you can install LuaTeX-ja via tlmgr.
+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:
 
 
 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
       <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.
 
       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


@@ -51,6 +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.)

 
 

-Last commit date: $Format:%cd$
+  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$