summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/kanbun/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/kanbun/README.md')
-rw-r--r--macros/latex/contrib/kanbun/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/macros/latex/contrib/kanbun/README.md b/macros/latex/contrib/kanbun/README.md
new file mode 100644
index 0000000000..3b6e755d2d
--- /dev/null
+++ b/macros/latex/contrib/kanbun/README.md
@@ -0,0 +1,24 @@
+# The `kanbun` package
+
+The `kanbun` package, like other *kanbun-kundoku* (漢文訓読) LaTeX packages (such as `gckanbun`), allows users to manually input macros for elements in a *kanbun-kundoku* paragraph.
+
+More importantly, it accepts plain text input in the “*kanbun* annotation” form when used with LuaLaTeX, which allows typesetting *kanbun-kundoku* paragraphs efficiently.
+
+## Licence
+
+Copyright 2022 Yuanhao Chen
+
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either version 1.3
+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 Yuanhao Chen.
+
+This work consists of the files `kanbun.sty`, `kanbun.lua`,
+`kanbun-example.tex` and `kanbun.tex`.