summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/emoji/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/emoji/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/emoji/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/emoji/README.md b/Master/texmf-dist/doc/latex/emoji/README.md
new file mode 100644
index 00000000000..ee0ee3456d2
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/emoji/README.md
@@ -0,0 +1,38 @@
+# The `emoji` package
+
+[![CTAN](https://img.shields.io/ctan/v/emoji.svg)](https://www.ctan.org/pkg/emoji)
+[![GitHub release](https://img.shields.io/github/release/stone-zeng/latex-emoji/all.svg)](https://github.com/stone-zeng/latex-emoji/releases/latest)
+
+Emoji support in (Lua)LaTeX.
+
+## Introduction
+
+The `emoji` package allows user to typeset emoji in a LaTeX document. It requires LuaHBTeX engine,
+which can be called by `lualatex` in TeX Live 2020 or `lualatex-dev` in TeX Live 2019.
+
+## Usage
+
+```tex
+\documentclass{article}
+\usepackage{emoji}
+\setemojifont{Apple Color Emoji} % Optional
+
+\begin{document}
+\emoji{joy}
+\emoji{+1}
+\emoji{family-man-woman-girl-boy}
+\emoji{woman-and-man-holding-hands-light-skin-tone-medium-dark-skin-tone}
+\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.