beffroi-tools/README.md

54 lines
2.3 KiB
Markdown

# beffroi-tools
![current version](https://assets.dandaedre.com/coverage/Beffroi/beffroi-tools/main/version.svg)
![test status](https://assets.dandaedre.com/coverage/Beffroi/beffroi-tools/main/test.svg)
![line coverage](https://assets.dandaedre.com/coverage/Beffroi/beffroi-tools/main/coverage.svg)
Local document and media tools: a Rust PPTX video reporter with a drag-and-drop
app, a spreadsheet rundown converter for Ontime, an ASCII filename cleaner,
and Python document exports.
## Quick start
On Windows, extract the portable ZIP and open `pptx-reporter-gui.exe`.
Drop PPTX files or a video folder into the window, select report formats, and generate.
Keep the bundled `ffprobe.exe` beside the app.
On macOS 13+, extract the portable ZIP for Apple Silicon (`aarch64`) or Intel
(`x86_64`) and run `./pptx-reporter-gui`. FFprobe is included; keep it beside the app.
See [macOS release details](docs/releases.md#macos).
To run from source:
```sh
cargo run --locked --bin pptx-reporter-gui
cargo run --locked --bin pptx-reporter -- presentation.pptx --report all
cargo run --locked --bin pptx-reporter -- ./show --timings-only --report ontime
cargo run --locked -p rundown-converter --bin rundown-converter-gui
cargo run --locked -p ascii-names
python3 tools/exporter.py presentation.pptx --output pdf,images
```
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`.
## PPTX reporter visual guide
**[Follow the illustrated PPTX reporter 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 formats and timing semantics](docs/pptx-videos.md)
- [ASCII filename cleaner](docs/ascii-names.md)
- [Document exports](docs/exporter.md)
- [Rundown converter](docs/rundown-converter.md) · [Sample findings](docs/rundown-corpus.md)
- [Development](docs/development.md) · [CI and coverage](docs/ci.md)
- [Cross builds and portable releases](docs/releases.md)
- [MPC-HC Companion module development](companion-modules/media-player-classic/README.md)
- [Future ideas](Ideas.md)