Structure README around quick start and visual guide
Beffroi/beffroi-tools/pipeline/head There was a failure building this commit Details

This commit is contained in:
Dandaedre 2026-10-20 14:44:17 +02:00
parent 1b2925eb9c
commit 6ad0bc71d1
1 changed files with 17 additions and 1 deletions

View File

@ -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)