summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/emoji/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/luatex/latex/emoji/README.md')
-rw-r--r--macros/luatex/latex/emoji/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/macros/luatex/latex/emoji/README.md b/macros/luatex/latex/emoji/README.md
new file mode 100644
index 0000000000..7b97828ea4
--- /dev/null
+++ b/macros/luatex/latex/emoji/README.md
@@ -0,0 +1,35 @@
+# The `emoji` package
+
+Emoji support in (Lua)LaTeX.
+
+## Introduction
+
+The `emoji` package allows user to typeset emoji in a LaTeX document. It requires LuaHBTeX, or `lualatex-dev` at present.
+
+## Usage
+
+```tex
+\documentclass{article}
+\usepackage{emoji}
+\setemojifont{Apple Color Emoji} % Optional
+
+\begin{document}
+\emoji{joy}
+\emoji{+1}
+\emoji{family-man-woman-girl-boy}
+\end{document}
+```
+
+Result:
+
+> 😂
+> 👍
+> 👨‍👩‍👧‍👦
+
+## License
+
+This work may be distributed and/or modified under the conditions of the [LaTeX Project Public License](http://www.latex-project.org/lppl.txt), either version 1.3c of this license or (at your option) any later version.
+
+-----
+
+Copyright (C) 2020 by Xiangdong Zeng.