From ef376849963f7ce2b1270e7a68b9f4f21f19d316 Mon Sep 17 00:00:00 2001 From: "Marei (peiTeX)" Date: Thu, 21 Oct 2021 22:57:05 +0200 Subject: [PATCH] add quickstart info to the readme --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a0f4c31..ed2fb5f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,40 @@ Create Handouts with notes from your LaTeX beamer presentation. This package provides pgfpages layouts to place notes next to the scaled slides. By default the note area is empty providing rules for handwritten notes but with version 1.0 also beamer note pages can be used there. -Detailed information on how to use this sty file to create the notes for you presentation can be found in the blog post: https://www.guidodiepen.nl/2009/07/creating-latex-beamer-handouts-with-notes/ + + +# Quickstart +To use this package load it in a document using beamer and select a layout: + +Minimal example: +``` +\documentclass{beamer} +\usepackage{handoutWithNotes} +\pgfpagesuselayout{3 on 1 with notes} +\begin{document} +… +\end{document} +``` + +Currently the following layouts are implemented by this package: + +- `1 on 1 with notes landscape` +- `2 on 1 with notes landscape` +- `1 on 1 with notes` +- `2 on 1 with notes` +- `3 on 1 with notes` +- `4 on 1 with notes` + +Additionally we support the following package options: + +- `slide-frame=true/false` draw a frame around the slides +- `note-frame=true/false` draw a frame around the note pages +- `beamer-notes=true/false` use beamer notepages instead of the area for handwritten notes +- `lines=` modify the number of lines in the notesbox (default is 8) + + +# Documentation +A detailed documentation will follow but until this is done most information can be found in the blog post: https://www.guidodiepen.nl/2009/07/creating-latex-beamer-handouts-with-notes/ # Version History * v1.00 (2021-10-21) First CTAN Version