README

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