README

   1 The LuaTeX-ja Package $VER$
   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 have questions or recognize bugs/have feature requests,
  16 we would like you to create a thread in the forum or a ticket
  17 in the way which SourceForge.JP supplies, via links found in
  18 the page above.
  19
  20
  21 Installation
  22 ------------
  23
  24 0. Please make sure that your TeX distribution is up-to-date.
  25    LuaTeX-ja (luatexja-fontspec.sty) requires xunicode.sty v0.981.
  26
  27 1. If you are using TeX Live 2011 or later, you can install LuaTeX-ja via tlmgr.
  28
  29 2. If you must/want to install manually:
  30
  31    a. Download the source archive from CTAN,
  32       or tagged as $VER$ in the Git repository by
  33       <http://git.sourceforge.jp/view?p=luatex-ja/luatexja.git
  34                               ;a=snapshot;h=refs/tags/$VER$;sf=tgz>
  35
  36    b. Extract the archive and put src/ into your TEXMF tree.
  37       An example location is TEXMF/tex/luatex/luatexja.
  38
  39       If you are updating from old version, you MUST remove it before
  40       extracting the new version of LuaTeX-ja.
  41
  42    c. You may need to update the filename database, by 'mktexlsr' or something.
  43
  44
  45 Basic Usage
  46 -----------
  47
  48 LuaTeX-ja supports both the plain format and LaTeX2e.
  49 Simply loading luatexja.sty by \input or \usepackage does the minimal setting.
  50
  51 - If you want to create Japanese-based documents, you can consider the use of
  52   ltj{article,book,report}.cls or ltjs{article,book}.cls.
  53 - If you want to use the fontspec package, please load luatexja-fontspec.sty.
  54   It defines control sequences such as \setmainjfont, setsansjfont and
  55   \jfontspec, which can be used for specifying Japanese fonts.
  56
  57
  58 Last commit date: $Format:%cd$
  59