Introduction
------------
xpinyin is a LaTeX package written to simplify the input of Hanyu Pinyin.
The package provides macros to automatically add pinyin to Chinese characters.
It can only be used in conjunction with xeCJK or CJK/CJKutf8 package.

Given that the implementation of pinyin package of CJK bundle is not very
well, it seems that xpinyin is a good replacement of it.

You can read the package manual (in Chinese) for more detailed explanations.

It may be distributed and/or modified under the conditions of the
LaTeX Project Public License (LPPL), either version 1.3c of this license or
(at your option) any later version. The latest version of this license is in

   http://www.latex-project.org/lppl.txt

and version 1.3 or later is part of all distributions of LaTeX version
2005/12/01 or later.

This work has the LPPL maintenance status "maintained".
The Current Maintainer of this work is Qing Lee.

This package consists of the file  xpinyin.dtx,
             and the derived files xpinyin.sty,
                                   xpinyin.pdf,
                                   xpinyin.ins,
                                   xpinyin.lua,
                                   xpinyin.db,
                                   xpinyin-database.def and
                                   README (this file).

Author
------
Qing Lee
Email: sobenlee@gmail.com

If you are interested in the process of development you may observe

    https://github.com/CTeX-org/ctex-kit

Installation
------------
The package is supplied in dtx format and as a pre-extracted zip file,
xpinyin.tds.zip. The later is most convenient for most users: simply
unzip this in your local texmf directory and run texhash to update the
database of file locations. If you want to unpack the dtx yourself,
running "luatex xpinyin.ins" will extract the package whereas
"xelatex xpinyin.dtx" will typeset the documentation.

The package requires LaTeX3 support as provided in the l3kernel and l3packages
bundles. Both of these are available on CTAN as ready-to-install zip files.
Suitable versions are available in the latest version of MiKTeX and TeX Live
(updating the relevant packages online may be necessary).

To compile the documentation without error, you will need the xeCJK package
and some specific Chinese Simplified fonts (TrueType or OpenType).
