summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/emojicite/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/luatex/latex/emojicite/README.md')
-rw-r--r--macros/luatex/latex/emojicite/README.md72
1 files changed, 72 insertions, 0 deletions
diff --git a/macros/luatex/latex/emojicite/README.md b/macros/luatex/latex/emojicite/README.md
new file mode 100644
index 0000000000..7c72f2552c
--- /dev/null
+++ b/macros/luatex/latex/emojicite/README.md
@@ -0,0 +1,72 @@
+# emojicite
+
+[[CTAN](https://www.ctan.org/tex-archive/macros/luatex/latex/emojicite)] |
+[[PDF Docu](http://mirrors.ctan.org/macros/luatex/latex/emojicite/emojicite-doc.pdf)]
+
+Scientific publications are too dry. Too much math, too little emotions. Science
+needs emojis!
+Leave a small heart to value the hard work gone into a paper (Smith, 2014 โค๏ธ ).
+Flag self-citations as in (Sixt et al., 2019 ๐Ÿคณ)
+Finally, you can express what you truly think directly as in (Wakefield et. al, 1998 ๐Ÿคฆ).
+We could also indicate, how thoroughly we read papers (Van Wesel et al., 2014 ๐Ÿ™ˆ)
+
+## Basic Usage
+
+```
+\documentclass{article}
+
+\usepackage{emojicite}
+\setcitestyle{authoryear, round}
+\bibliographystyle{plainnat}
+
+\begin{document}
+
+\emojicitep{einstein, kissing-heart}
+
+\bibliography{bibliography}
+\end{document}
+```
+
+See [example.tex](./example.tex) for basic usage.
+
+## Examples
+
+Table 1: How did you liked the cited work?
+
+| Citation | Emoji | Description |
+|--------------------------------|:--------------:|:---------------------|
+| (Einstein, 1905 ๐Ÿ˜˜) | kissing-heart | I like this work. Here is a kiss.
+| (Shannon, 1948 ๐Ÿ™‡) | bow | Wow, I can only bow to this work.
+| (Kim et al., 2017 ๐Ÿ‘) | +1 | Good work!
+| (Zhang and Cheok, 2016 ๐Ÿ˜• ) | confused | I am confused by this work.
+| (Le Cun et al., 1989 ๐Ÿฅฑ) | yawning-face | Boring work.
+| (Tishby and Zaslavsky, 2015 ๐Ÿคจ)| raised-eyebrow | I have some serious questions...
+| (Wakefield et al., 1998 ๐Ÿคฆ) | facepalm | omg, this work sucks!
+
+
+Table 2: How thoroughly have you read the work?
+
+| Citation | Emoji | Description |
+|--------------------------------|:--------------:|:---------------------|
+| (Kingma and Welling, 2013 ๐Ÿค“) | nerd-face | I know everything about this work.
+| (Kim et al., 2017 ๐ŸŽ“) | graduation-cap | I know this work well.
+| (Shannon, 1948 ๐Ÿค”) | thinking | I read it but I still have questions.
+| (Jones, 1972 ๐Ÿ™ˆ) | see-no-evil | Ups, I did not read this work in-depth.
+| (Einstein, 1905 ๐Ÿคท) | shrug | too long; did not read
+
+See [PDF Docu](http://mirrors.ctan.org/macros/luatex/latex/emojicite/emojicite-doc.pdf) for more examples.
+
+
+## Requirements
+
+The package requires the Tex Live 2020 distributon and you need to use lualatex.
+If you use the `latexmk` tool, simple use `latexmk -pdflua`. See the
+[emoji](https://github.com/stone-zeng/latex-emoji) package for are in-depth
+description on the requirements.
+
+
+-----
+
+Copyright (C) 2020 by Leon Sixt.
+
+๐Ÿ™ to Xiangdong Zeng creator of [emoji](https://github.com/stone-zeng/latex-emoji)