summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/sillypage/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2022-01-11 03:01:10 +0000
committerNorbert Preining <norbert@preining.info>2022-01-11 03:01:10 +0000
commit39394e7cba63ab69525546760c8e542bb98f48e0 (patch)
tree9a63254086c5722f6670adad372c9c68efcb4948 /macros/latex/contrib/sillypage/README.md
parentd50bfeb7feb32d585a89393c364ef5f9e1b915d0 (diff)
CTAN sync 202201110301
Diffstat (limited to 'macros/latex/contrib/sillypage/README.md')
-rw-r--r--macros/latex/contrib/sillypage/README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/macros/latex/contrib/sillypage/README.md b/macros/latex/contrib/sillypage/README.md
new file mode 100644
index 0000000000..1a04f51626
--- /dev/null
+++ b/macros/latex/contrib/sillypage/README.md
@@ -0,0 +1,54 @@
+# The `sillypage` package
+
+This is a very simple package that provides John Cleese's iconic silly walk
+routine as page numbering style.
+
+## Usage
+
+Simply add `\usepackage{sillypage}` to your document. Then:
+
+- Write `\pagenumbering{silly}` in you document to use the page numbering
+ style defined by this package.
+- Use the macro `\silly` on a LaTeX counter to typeset the corresponding
+ image for the value of that counter.
+- Use the macro `\sillystep` to print the step number `n` from the
+ sequence of steps.
+
+## A sample document
+
+Here we go:
+
+```tex
+\documentclass{article}
+
+\usepackage{sillypage}
+\usepackage{blindtext}
+
+\begin{document}
+\pagenumbering{silly}
+\Blinddocument
+\end{document}
+```
+
+## Installation notes
+
+Just note that `sillywalk-map.png` should go under the `tex/` subtree
+(as it is required by `sillypage.sty`) instead of the `doc/` counterpart.
+
+## Isn't this package too silly?
+
+Yes.
+
+## Authors
+
+Blame these two blokes:
+
+- Phelype Oleinik
+- Paulo Cereda
+
+## License
+
+The `sillypage` package may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either version 1.3c of
+this license or (at your option) any later version.
+