Skip to content

Commit cb54072

Browse files
committed
Clean up README, elaborate on usage and documentation
1 parent 64d2693 commit cb54072

File tree

1 file changed

+56
-6
lines changed

1 file changed

+56
-6
lines changed

pdfpc/README.md

Lines changed: 56 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# pdfpc
22

3-
This packages allows to define additional meta data within
4-
the PDF file which can be interpreted by the pdf presenter
5-
console (pdfpc) program.
3+
This LaTeX package provides a convenient way to specify notes and to define
4+
certain meta properties of the presentation when used with [PDF Presenter
5+
Console (`pdfpc`)](https://pdfpc.github.io), a GPLv3+ licensed multi-monitor PDF
6+
presentation viewer application available on GitHub.
7+
68

79
## Dependencies
810

9-
`pdfpc` depends on these packages:
11+
The `pdfpc` package depends on these other packages:
1012
[`kvoptions`](https://ctan.org/pkg/kvoptions),
1113
[`xstring`](https://ctan.org/pkg/xstring),
1214
[`iftex`](https://ctan.org/pkg/iftex),
@@ -16,8 +18,56 @@ When using LuaTeX, it additionally depends on these packages:
1618
[`stringenc`](https://ctan.org/pkg/stringenc),
1719
[`pdftexcmds`](https://ctan.org/pkg/pdftexcmds)
1820

21+
1922
## Usage
2023

21-
It's best to read the [`pdfpc`](https://github.com/pdfpc/pdfpc) documentation
22-
for `pdfpc` integration.
24+
The [PDF Presenter Console](https://pdfpc.github.io) program accepts a variety
25+
of configuration options when started from the command line. (See the *pdfpc(1)*
26+
manual page for details.)
27+
28+
This package allows certain details, such as presentation duration, default
29+
slide transitions, and speaker notes, to be specified within the metadata of the
30+
PDF itself, instead of via the command line. These settings are parsed by the
31+
PDF Presenter Console when the presentation is loaded.
32+
33+
These parameters can be specified as package options, and/or via the `\pdfpcsetup` command.
34+
35+
The following is a simple LaTeX document demonstrating a few example features:
36+
37+
```latex
38+
\documentclass{beamer}
39+
\usepackage[overridenote]{pdfpc}
40+
% "overridenote" must be specified as a package option
41+
\pdfpcsetup{
42+
% Other settings can be package options, or can go here
43+
duration=5,
44+
lastminutes=2,
45+
}
46+
47+
% The usual Beamer document setup
48+
\title{\texttt{pdfpc} Example Presentation}
49+
\author{LRitzdorf}
50+
\institute{GitHub}
51+
\date{\today}
52+
53+
\begin{document}
54+
\maketitle
55+
56+
\begin{frame}
57+
Hello PDFPC World!
58+
% Because of "overridenote", this uses the pdfpc note command
59+
\note{This speaker note will be shown by `pdfpc`, but hidden for the audience.}
60+
\pause
61+
Notice that the timer starts counting down from 5 minutes, just as we specified in the preamble!
62+
\end{frame}
63+
64+
\end{document}
65+
```
66+
67+
68+
## Documentation
2369

70+
Complete
71+
[documentation](http://mirrors.ctan.org/macros/latex/contrib/pdfpc/pdfpc-doc.pdf)
72+
for the current version of `pdfpc` is availble on [its CTAN
73+
page](https://ctan.org/pkg/pdfpc).

0 commit comments

Comments
 (0)