diff --git a/Cargo.lock b/Cargo.lock index eeb3335..11a1d18 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2245,7 +2245,7 @@ dependencies = [ [[package]] name = "pdf-presenter" -version = "0.1.83" +version = "0.1.84" dependencies = [ "bytemuck", "chrono", diff --git a/Cargo.toml b/Cargo.toml index d842f1a..9e2cdd7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,7 +4,7 @@ default-members = ["crates/pdf-presenter"] resolver = "3" [workspace.package] -version = "0.1.83" +version = "0.1.84" edition = "2024" license = "MIT" repository = "https://proxy.dandaedre.com/gitea/idle-org/pdf-presenter" diff --git a/README.md b/README.md index 1fb06d1..48657ca 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ PDF Presenter icon

PDF Presenter

-

Your slides on the big screen. Your notes and controls with you.

+

A fast, portable presenter for PDFs and picture folders.

+

Fullscreen slides for the room. Notes, previews and controls for you.

Version @@ -11,101 +12,128 @@

- Download a release · - Install and update · + Download PDF Presenter · User guide · Report an issue

-PDF Presenter is a desktop presenter for **PDFs and picture folders**. Show slides -fullscreen on your Slides screens while keeping previews, notes, timers and -navigation on your Presenter screens. Rehearse on one monitor, or mirror either view -across several displays. +PDF Presenter gives each connected screen a job: **Presenter**, **Slides**, or +**Unused**. Keep the current slide, next slide, notes and timers in front of you +while one or more other screens show only the presentation. You can also mirror the +Presenter view, rehearse on one monitor, or change the arrangement during a session. -## Open source and development +

+ Presenter view showing the current slide, next slide, fitted notes, timer and navigation +

-PDF Presenter is open-source software under the [MIT license](LICENSE). Its -development includes LLM-generated or LLM-assisted work, with human review. -It is used in professional settings; supported workflows and current -limitations are documented in this repository. +The application is built around a simple requirement: advancing a slide should feel +immediate. Prepared slides are buffered in RAM, reusable processed images make a +second opening faster, and large decks use a rolling buffer instead of exhausting +memory. Rendering, notes and file work run outside the presentation controls so a +slow document operation does not have to freeze navigation. -## Download, extract, present +## What it does well -Start with the [release downloads](https://proxy.dandaedre.com/gitea/idle-org/pdf-presenter/releases). -Choose a **portable** package for your computer; no Rust toolchain or separate PDF -renderer is needed. +| Feature | What it means while presenting | +| --- | --- | +| **Real multi-screen control** | Assign Presenter or Slides to every connected monitor. Repeat either role across several screens. Display changes use a confirmation timer and revert if the new arrangement is wrong. | +| **Layouts for each Presenter screen** | Resize or hide the current slide, next slide, previous slide, notes, timers and progress bar. Save a layout for one project or as a default, with separate preferences for different screens. | +| **Fast, visible preparation** | The Presenter reports what it is preparing, RAM use and an ETA when available. Prepared nearby slides are served from RAM; a bounded rolling buffer reloads distant slides only when needed. | +| **Useful live tools** | Point, draw arrows and highlight without modifying the PDF or rerendering slide images. Tool size follows the visible slide, including high-resolution output. | +| **Shared zoom** | Opt in to zoom, pan or fit a page to width from Presenter or Slides. Both views stay on the same part of the page. | +| **Safe slide browsing** | Browse resizable thumbnails without changing the live slide. Double-click to preview, or enable **Change on click** when direct switching is useful. | +| **Notes that belong to the presentation** | Read notes from a sidecar or the PDF, import TXT/Markdown, and double-click the notes pane to edit the current slide. Notes automatically fit the available space. | +| **Presentation-aware desktop behavior** | PDF Presenter asks supported operating systems to keep the display awake and reports whether protection is active. Closing Presenter also closes its Slides windows. | +| **Portable by design** | The release binaries include the PDF renderer and application dependencies. Keep the extracted folder anywhere convenient; no Rust or separate PDF software is required. | -| Your computer | Download | Run after extracting | +On Windows, multi-screen output, per-screen layouts, zoom, tools, and unplugging then +reconnecting displays have been tested in extended use. Linux and macOS use the same +presentation model, but desktop and window-manager behavior still deserves testing +on the machines that will run the show. + +## Download and run + +Open the [release page](https://proxy.dandaedre.com/gitea/idle-org/pdf-presenter/releases) +and download the archive for your computer. + +| Platform | Recommended download | Start after extracting | | --- | --- | --- | | Windows x86_64 | `pdf-presenter-portable-x86_64-pc-windows-gnu-v….zip` | `pdf-presenter.exe` | | Linux x86_64 | `pdf-presenter-portable-x86_64-unknown-linux-gnu-v….tgz` | `./pdf-presenter` | +| Apple Silicon macOS 13+ | v0.1.83 `pdf-presenter-aarch64-apple-darwin-v….tgz` | Follow the release-page instructions for the unsigned executable | -Releases are currently **previews**. Windows binaries are unsigned; macOS downloads -are not yet available. Test your display setup before using it for a live event. -[Installation, updates and optional Linux app-menu integration →](docs/user-guide.md#install-and-update) +Windows and macOS builds are currently unsigned. Releases are previews, so test the +actual computer, adapters and display arrangement before a live event. The macOS +artifact is a one-off cross-build in v0.1.83 and has not yet had native Mac runtime +testing. [Installation and update details →](docs/user-guide.md#install-and-update) -## Set up your presentation +## Set up a show -1. **Open your slides.** Choose Menu → Open PDF or Open picture folder, or drop your - file/folder onto the presenter. Pictures follow natural filename order. -2. **Choose your screens.** In Displays, assign Presenter or Slides to each - monitor. Try the arrangement, then keep it or let it revert automatically. -3. **Make room for what matters.** In Layout, resize or hide previews and notes, - place the timers, and optionally enable slide progress. Save for this project - or all projects. -4. **Present.** Use arrows or Space to advance. Type a slide number and press Enter - to jump. All slides opens a thumbnail browser; B blanks or restores the output. +1. **Open a PDF or picture folder.** Use Menu, drag and drop, or open an associated + PDF on Windows. Pictures follow natural filename order. +2. **Choose where each view goes.** Open **Displays**, select Presenter, Slides or + Unused for each monitor, then apply the change. Keep the proposal or let it revert. +3. **Arrange your Presenter view.** Open **Layout** to size and position slides, + notes, clocks and progress. Save it for this presentation or for all projects. +4. **Present.** Use Left/Right, Page Up/Page Down or Space. Type a slide number and + press Enter to jump directly to it. Press B to blank or restore Slides. -Opening a document shows the presentation by default. Changing displays or fullscreen -preserves whether you have shown or blanked the output. Hide the bars for more space; move the -pointer near an edge or right-click to recover them. +PDF Presenter shows Slides by default after a document opens. Entering or leaving +fullscreen and changing screen assignments preserve that choice. Header and footer +controls can auto-hide; move the pointer near their edge or right-click to recover +them. -Prepared slides are cached for reuse. The presenter shows loading progress, RAM use -and an ETA when available; decks larger than the RAM budget use a rolling buffer. -Notes can come from the PDF or picture-folder sidecars. Themes and English/French -controls are available in Menu. Optional shared slide zoom is available under -**Menu → Enable page zoom**; scroll to zoom, drag to pan, double-click -to reset on the current preview or Slides screen. + + + + + + + + + +
Displays panel assigning Presenter and Slides across two monitorsAll slides browser with three resizable slide thumbnails
Route and mirror screensBrowse without disturbing the live slide
-## Import your notes +## Zoom and point while presenting -Open your presentation, then choose **Menu → Import notes…**, or drop a `.txt` or -`.md` file onto the presenter window. Review the import and choose **Import and save -notes**. This creates or updates `presentation.notes.toml` beside `presentation.pdf` -(or `Slides.notes.toml` beside a picture folder named `Slides`). Your original notes -file and slides stay untouched. Double-click the notes pane to edit a slide later. +Enable page zoom from Menu when a document needs it. Scroll to zoom, drag to pan, +and double-click to fit the page width or reset. The crop is shared with Slides and +uses the already buffered image. -**TXT:** separate slides with a line containing two or more hyphens: +Open **Tools** for a pointer, arrows and a highlighter. Marks remain vector overlays +on the current slide and can be undone or cleared instantly. Their apparent size is +scaled between the smaller Presenter preview, 1080p output and 4K output. -```text -Welcome everyone. -------- -Explain the results. -------- -Thank the audience. -``` +

+ Presenter view with the pointer toolbox open and a pointer visible on the current slide +

-**Markdown:** start each slide with a top-level `#` title. Titles are separators; -only their body becomes the slide's notes: +## Slides, notes and shortcuts -```markdown -# Introduction -Welcome everyone. -# Results -Explain the results. -# Conclusion -Thank the audience. -``` +PDFs work directly. A picture folder becomes a deck using natural filename order; +for example, `slide_2.png` comes before `slide_10.png`. Notes may come from embedded +PDF annotations, a `.notes.toml` sidecar, per-slide text files, or imported TXT and +Markdown. Source slides and imported note files are not overwritten. -Sections map to slides **in order, starting at slide 1**; titles do not select slide -numbers. Fewer sections preserve the remaining slides' notes; too many sections -reject the import without writing. Empty sections clear a slide's notes. TXT files -need no final separator (a final separator creates an empty section). Use UTF-8. -Markdown `##` subheadings and headings inside fenced code stay in the note; -nonblank text before the first `#` title is rejected. Notes display as plain text. -[Format details and limits →](docs/interfaces/presentation-notes.md#importing-txt-and-markdown) +Useful controls: -[**Read the user guide →**](docs/user-guide.md) +- **Right / Space** — next slide +- **Left / Shift+Space** — previous slide +- **Number, then Enter** — jump to a slide +- **B** — blank or restore Slides +- **P / A / H** — pointer, arrow or highlighter +- **Escape** — cancel the current popup or display proposal; fullscreen has its own button + +[Notes, layouts and controls →](docs/user-guide.md) · +[Notes file formats →](docs/interfaces/presentation-notes.md) · +[Preparation, cache and RAM behavior →](docs/user-guide.md#preparation-processed-slides-and-ram) + +## Open source + +PDF Presenter is independent open-source software under the [MIT license](LICENSE). +Development includes LLM-generated or LLM-assisted work with human review. The +project is used in professional settings, while preview limitations and physical +acceptance work remain documented rather than hidden. --- diff --git a/docs/changelog.md b/docs/changelog.md index 602533f..dfcb58e 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -2,6 +2,14 @@ ## Unreleased +### 0.1.84 + +- Rewrite the root README for presenters: lead with the tested multi-screen workflow, + per-screen layouts, fast buffered navigation, monitor reconnection, zoom, live + tools, safe slide browsing and portable release downloads. +- Add real application screenshots made with the repository's fictional demo PDF, + covering Presenter, display routing, All slides and the pointer toolbox. + ### 0.1.83 - Scale pointers, highlights, arrow shafts and arrow heads against the visible slide diff --git a/docs/images/all-slides.png b/docs/images/all-slides.png new file mode 100644 index 0000000..6825dbe Binary files /dev/null and b/docs/images/all-slides.png differ diff --git a/docs/images/display-routing.png b/docs/images/display-routing.png new file mode 100644 index 0000000..d638df4 Binary files /dev/null and b/docs/images/display-routing.png differ diff --git a/docs/images/presenter-overview.png b/docs/images/presenter-overview.png new file mode 100644 index 0000000..296278f Binary files /dev/null and b/docs/images/presenter-overview.png differ diff --git a/docs/images/presenter-tools.png b/docs/images/presenter-tools.png new file mode 100644 index 0000000..5df6b23 Binary files /dev/null and b/docs/images/presenter-tools.png differ