summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/clicks/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/clicks/README.md')
-rw-r--r--macros/latex/contrib/clicks/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/macros/latex/contrib/clicks/README.md b/macros/latex/contrib/clicks/README.md
new file mode 100644
index 0000000000..22817f6ebe
--- /dev/null
+++ b/macros/latex/contrib/clicks/README.md
@@ -0,0 +1,31 @@
+[![make](https://github.com/yegor256/clicks/actions/workflows/latexmk.yml/badge.svg)](https://github.com/yegor256/clicks/actions/workflows/latexmk.yml)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/clicks/blob/master/LICENSE.txt)
+
+This LaTeX package adds nagivation clicks to your document, which
+may be very useful for presentation and slide decks.
+
+First, [install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages)
+from [CTAN](https://ctan.org/pkg/clicks)
+and then use in the preamble:
+
+```tex
+\documentclass{article}
+\usepackage{clicks}
+\usepackage{fancyhdr}
+\fancyhead[L]{\clicks}
+\begin{document}
+\section{Introduction}
+Some text here.
+\section{Related Works}
+Some other text here.
+\end{document}
+```
+
+The full example and all commands are available in the
+[`clicks.tex`](https://github.com/yegor256/clicks/blob/master/clicks.tex) file.
+
+If you want to contribute yourself, make a fork, then create a branch,
+then run `make` in the root directory.
+It should compile everything without errors. If not, submit an issue and wait.
+Otherwise, make your changes and then run `make` again. If the build is
+still clean, submit a pull request.