Skip to content

Commit

Permalink
chore: link speaker notes guide in README
Browse files Browse the repository at this point in the history
  • Loading branch information
mfontanini committed Feb 2, 2025
1 parent 3911f15 commit a02b8c4
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Visit the [documentation][guide-introduction] to get started.
* [Pause][guide-pauses] portions of your slides.
* [Custom key bindings][guide-key-bindings].
* [Automatically reload your presentation][guide-hot-reload] every time it changes for a fast development loop.
* [Define speaker notes][guide-speaker-notes] to aid you during presentations.

See the [introduction page][guide-introduction] to learn more.

Expand All @@ -69,6 +70,7 @@ See the [introduction page][guide-introduction] to learn more.
[guide-pdf-export]: https://mfontanini.github.io/presenterm/guides/pdf-export.html
[guide-key-bindings]: https://mfontanini.github.io/presenterm/guides/configuration.html#key-bindings
[guide-hot-reload]: https://mfontanini.github.io/presenterm/guides/basics.html#hot-reload
[guide-speaker-notes]: https://mfontanini.github.io/presenterm/guides/speaker-notes.html
[bat]: https://github.com/sharkdp/bat
[syntect]: https://github.com/trishume/syntect

Expand Down
8 changes: 8 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,11 @@ This example shows how column layouts and pauses interact with each other. Note
because asciinema doesn't support these and it will otherwise look like a normal image if your terminal supports images.

[![asciicast](https://asciinema.org/a/x2tTDt0BIesvOXeal3UpdzMHp.svg)](https://asciinema.org/a/x2tTDt0BIesvOXeal3UpdzMHp)

# Speaker notes

[Source](/examples/speaker-notes.md)

This example shows how to use speaker notes.

[![asciicast](https://asciinema.org/a/ETusvlmHuHrcLKzwa0CMQRX2J.svg)](https://asciinema.org/a/ETusvlmHuHrcLKzwa0CMQRX2J)

0 comments on commit a02b8c4

Please sign in to comment.