beffroi-tools/README.md

37 lines
1.6 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. This branch trials a Rust PPTX reporter with a
drag-and-drop desktop app, embedded PDF generation, and the existing CLI formats.
```sh
cargo run --locked --bin pptx-reporter-gui
cargo run --locked --bin pptx-reporter -- presentation.pptx --report all
```
Video timings need FFprobe (from FFmpeg); PDF generation is built in.
The Python reference and document exporter remain available (Python 3.9+):
```sh
# Extract videos with Markdown + Ontime reports (requires ffprobe).
python3 tools/pptx_videos.py presentation.pptx
# Export slides to PDF and PNG images (requires DeckCraft).
python3 tools/exporter.py presentation.pptx --output pdf,images
# Render PDF pages as PNG images (requires PdfCraft).
python3 tools/exporter.py document.pdf --output images
```
- [Video reports](docs/pptx-videos.md) — formats, extraction modes, and dependencies.
- [Document exports](docs/exporter.md) — image resolution, AppImages, and output options.
- [Development and CI](docs/development.md) — layout, tests, and Jenkins setup.
- [Rust reporter](docs/rust-reporter.md) — desktop usage, Windows/Cross builds,
portable packaging, release preparation, and coverage.
- [Trial task list](docs/rust-reporter-tasks.md) — progress and verification.
Run commands from the repository root. Each tool supports `--help`.