summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/yb-book/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/yb-book/README.md')
-rw-r--r--macros/latex/contrib/yb-book/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/macros/latex/contrib/yb-book/README.md b/macros/latex/contrib/yb-book/README.md
new file mode 100644
index 0000000000..a9eae33589
--- /dev/null
+++ b/macros/latex/contrib/yb-book/README.md
@@ -0,0 +1,25 @@
+[![make](https://github.com/yegor256/yb-book/actions/workflows/make.yml/badge.svg)](https://github.com/yegor256/yb-book/actions/workflows/make.yml)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/yb-book/blob/master/LICENSE.txt)
+
+This LaTeX class I use to format [my books](https://www.yegor256.com/books.html),
+which I sell [on Amazon](https://www.amazon.com/Yegor-Bugayenko/e/B01AM1QMDK).
+
+First, [install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages)
+from [CTAN](https://ctan.org/pkg/yb-book)
+and then use in the preamble:
+
+```tex
+\documentclass{yb-book}
+\renewcommand*\theauthor{Jeff Lebowski}
+\renewcommand*\thevolume{1}
+\renewcommand*\thetitle{New Book About OOP}
+\begin{document}
+Hello, world!
+\end{document}
+```
+
+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.