summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/xpinyin/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/xpinyin/README.md')
-rw-r--r--macros/latex/contrib/xpinyin/README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/macros/latex/contrib/xpinyin/README.md b/macros/latex/contrib/xpinyin/README.md
new file mode 100644
index 0000000000..7c11c0fb0a
--- /dev/null
+++ b/macros/latex/contrib/xpinyin/README.md
@@ -0,0 +1,48 @@
+xpinyin
+=======
+
+`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.
+
+Contributing
+------------
+
+This package is a part of the [ctex-kit](https://github.com/CTeX-org/ctex-kit) project.
+
+Issues and pull requests are welcome.
+
+Copyright and Licence
+---------------------
+
+ Copyright (C) 2012-2019 by Qing Lee <sobenlee@gmail.com>
+ ----------------------------------------------------------------------
+
+ This work may be distributed and/or modified under the
+ conditions of the LaTeX Project Public License, either
+ version 1.3c of this license or (at your option) any later
+ version. This version of this license is in
+ http://www.latex-project.org/lppl/lppl-1-3c.txt
+ and 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.md (this file).
+