Skip to content

Commit

Permalink
add quickstart info to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
TeXhackse committed Oct 21, 2021
1 parent 402c7c0 commit ef37684
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<Number>` 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
Expand Down

0 comments on commit ef37684

Please sign in to comment.