From 6ad0bc71d14f7d898c73c16419a0ec53f3fa7899 Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Tue, 20 Oct 2026 14:44:17 +0200 Subject: [PATCH] Structure README around quick start and visual guide --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 02555a5..efdb42b 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,14 @@ Local document and media tools: a Rust PPTX video reporter with a drag-and-drop app, and Python tools for prototyping and document exports. +## Quick start + +On Windows, extract the portable ZIP and open `pptx-reporter-gui.exe`. +Drop a presentation into the window, select report formats, and generate. +Keep the bundled `ffprobe.exe` beside the app. + +To run from source: + ```sh cargo run --locked --bin pptx-reporter-gui cargo run --locked --bin pptx-reporter -- presentation.pptx --report all @@ -17,7 +25,15 @@ The reporter needs FFprobe (included in portable bundles); PDF generation is built in. The exporter needs DeckCraft for PPTX or PdfCraft for PDF input. Run source commands from the repository root; CLI tools support `--help`. -- [Illustrated user guide](docs/user-guide.md) +## Visual guide + +**[Follow the illustrated user guide →](docs/user-guide.md)** + +Screenshots walk you through choosing a presentation, selecting formats, +opening reports, and reading video timings. + +## More documentation + - [Reporter](docs/rust-reporter.md) · [Windows quick start](docs/windows-quickstart.txt) - [Report options and Python reference](docs/pptx-videos.md) - [Document exports](docs/exporter.md)