diff options
author | Norbert Preining <norbert@preining.info> | 2021-09-05 03:01:31 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2021-09-05 03:01:31 +0000 |
commit | b1acf2edfe185dad0e33c76ffd94306f1e4530fe (patch) | |
tree | 90716c6f05f89f4430a3057d4410a00c63b1ee62 /macros/latex/contrib/crumbs/README.md | |
parent | f569b5dc84d8ea85a85d7e92a9bd54142e0b778e (diff) |
CTAN sync 202109050301
Diffstat (limited to 'macros/latex/contrib/crumbs/README.md')
-rw-r--r-- | macros/latex/contrib/crumbs/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/macros/latex/contrib/crumbs/README.md b/macros/latex/contrib/crumbs/README.md new file mode 100644 index 0000000000..d01b1cc418 --- /dev/null +++ b/macros/latex/contrib/crumbs/README.md @@ -0,0 +1,31 @@ +[![make](https://github.com/yegor256/crumbs/actions/workflows/latexmk.yml/badge.svg)](https://github.com/yegor256/crumbs/actions/workflows/latexmk.yml) +[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/crumbs/blob/master/LICENSE.txt) + +This LaTeX package adds nagivation crumbs 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/crumbs) +and then use in the preamble: + +```tex +\documentclass{article} +\usepackage{crumbs} +\usepackage{fancyhdr} +\fancyhead[L]{\crumbs} +\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 +[`crumbs.tex`](https://github.com/yegor256/crumbs/blob/master/crumbs.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. |