README

   1 The LuaTeX-ja Package 2012/04/19
   2 --------------------------------
   3 Copyright 2011--2012 The LuaTeX-ja project
   4
   5 LuaTeX-ja is a macro package for typesetting Japanese documents with LuaTeX.
   6 This package is highly affected by ASCII pTeX engine, but not a porting of it.
   7
   8 Note that this package is still *alpha-stage*; documentations are not complete
   9 and specifications are subject to change. Documentations are located at
  10   doc/man-en.pdf (en), doc/man-ja.pdf (ja), doc/manual-zh.pdf (zh).
  11
  12 LuaTeX-ja is developed on
  13   <http://sourceforge.jp/projects/luatex-ja/wiki/FrontPage(en)>.
  14 If you have questions/requests/bugs, please contact the project members via
  15 links found in the page above.
  16
  17
  18
  19 Installation
  20 ------------
  21
  22 0. Please make sure that your TeX distribution is up-to-date.
  23    Needed (additional) packages are:
  24    - xunicode.sty v0.981
  25    - filehook.sty
  26 1. If you use TeX Live 2011 or later, you can install LuaTeX-ja via tlmgr.
  27 2. If you must/want to install manually:
  28    a. Download the source archive from CTAN, or HEAD in the Git repository by
  29       <http://git.sourceforge.jp/view?p=luatex-ja/luatexja.git
  30                                                     ;a=snapshot;h=HEAD;sf=tgz>
  31    b. Extract the archive and put src/ into your TEXMF tree.
  32       An example location is TEXMF/tex/luatex/luatexja.
  33    c. Files in src/no_runtime/ are not used in the regular use,
  34       so you can remove them.
  35    d. You may need to update the filename database, by 'mktexlsr' or something.
  36
  37
  38 Basic Usage
  39 -----------
  40
  41 LuaTeX-ja supports both the plain format and LaTeX2e.
  42 Simply loading luatexja.sty by \input or \usepackage does the minimal setting.
  43
  44 - If you want to create Japanese-based documents, you can consider the use of
  45   ltj{article,book,report}.cls or ltjs{article,book}.cls.
  46 - If you want to use the fontspec package, please load luatexja-fontspec.sty.
  47   It defines control sequences such as \setmainjfont, setsansjfont and
  48   \jfontspec, which can be used for specifying Japanese fonts.
  49