diff --git a/README.md b/README.md index 21e23dd..31b94cf 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,133 @@ -# beffroi-tools +

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 tools for presentations, show timing, screen layouts and media workflows.

-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. +

+ Current version + Test status + Line coverage +

+ +

+ Portable releases · + Quick start · + What's new · + Development +

+ +## Choose your tool + + + + + + + + + + + + + + +
+ PPTX Reporter icon +

PPTX Reporter

+

Inspect presentation videos, read playback timings, and export reports or Ontime rundowns.

+

Desktop app · CLI

+

Visual walkthrough · Guide · Report formats

+
+ Rundown Converter icon +

Rundown Converter

+

Turn spreadsheet rundowns into Ontime schedules, with timing checks before export.

+

Desktop app · CLI

+

Guide · Sample findings

+
+ Midra Layout icon +

Midra Layout

+

Arrange screen layers, exchange geometry, and review transfers to an Eikos 4K device.

+

Desktop app

+

Guide · Templates · Geometry formats

+
+ ASCII Names icon +

ASCII Names

+

Clean up filenames to ASCII with paced renames, collision protection, and unchanged file contents.

+

Desktop app · CLI

+

Guide

+
+ Document Exporter icon +

Document Exporter

+

Export PPTX to PDF or slide images, render PDF pages, and compress PDFs to a target size.

+

Python CLI

+

Guide and dependencies

+
+ MPC-HC Companion icon +

MPC-HC Companion

+

Control Media Player Classic Home Cinema from Companion with playback actions and player feedback.

+

Companion 5.1 module

+

Setup and development

+
## 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. +**Start with a portable app:** see [release bundles and platform instructions](docs/releases.md). +For PPTX Reporter, extract the ZIP and open `pptx-reporter-gui.exe` on Windows +or run `./pptx-reporter-gui` on macOS 13+. Choose the macOS archive for +[Apple Silicon or Intel](docs/releases.md#macos). Keep the bundled FFprobe 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). +Drop a presentation or video folder into the reporter, choose report formats, +and generate. The [illustrated guide](docs/user-guide.md) walks through each step; +a [Windows quick start](docs/windows-quickstart.txt) is also available. -To run from source: +
+Run from source — Rust apps and Python exporter + +Run these commands from the repository root: ```sh +# PPTX Reporter: desktop, full report, or Ontime timings 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 + +# Other desktop apps cargo run --locked -p rundown-converter --bin rundown-converter-gui +cargo run --locked -p midra-layout cargo run --locked -p ascii-names + +# Document exports 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`. +The reporter needs FFprobe; PDF generation is built in. The exporter needs +DeckCraft for PPTX or PdfCraft for PDF input. CLI tools support `--help`. +See [development setup](docs/development.md) for prerequisites and checks. + +
## Midra Layout templates -Midra also imports/exports native PPTX and Figma FIG; Illustrator AI uses an optional -local VectorCraft CLI. See [formats, dependencies and `no_proprietary` builds](docs/interfaces/midra-layout-exchange.md#optional-native-document-codecs-and-licensing-builds). +Ready-made canvases with two named 16:9 layers. Choose a size, then a format. + +
+Browse Full HD and UHD 4K templates — SVG, draw.io, JSON, CSV, DXF and HTML These starter files contain two named 16:9 layers on an exact pixel canvas. - **Full HD — 1920 × 1080:** [SVG](docs/templates/midra-layout/midra-layout-1080p-2-layers.svg) · [draw.io](docs/templates/midra-layout/midra-layout-1080p-2-layers.drawio) · [JSON](docs/templates/midra-layout/midra-layout-1080p-2-layers.json) · [CSV](docs/templates/midra-layout/midra-layout-1080p-2-layers.csv) · [DXF](docs/templates/midra-layout/midra-layout-1080p-2-layers.dxf) · [HTML](docs/templates/midra-layout/midra-layout-1080p-2-layers.html) - **UHD 4K — 3840 × 2160:** [SVG](docs/templates/midra-layout/midra-layout-4k-2-layers.svg) · [draw.io](docs/templates/midra-layout/midra-layout-4k-2-layers.drawio) · [JSON](docs/templates/midra-layout/midra-layout-4k-2-layers.json) · [CSV](docs/templates/midra-layout/midra-layout-4k-2-layers.csv) · [DXF](docs/templates/midra-layout/midra-layout-4k-2-layers.dxf) · [HTML](docs/templates/midra-layout/midra-layout-4k-2-layers.html) -## PPTX reporter visual guide +Midra also imports/exports native PPTX and Figma FIG; Illustrator AI uses an optional +local VectorCraft CLI. See [formats, dependencies and licensing builds](docs/interfaces/midra-layout-exchange.md#optional-native-document-codecs-and-licensing-builds). -**[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. +## Explore further -## More documentation - -- [Changelogs](docs/changelogs.md) — short per-tool change notes - -- [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) -- [Midra layout helper](docs/midra-layout.md) · [Geometry formats](docs/interfaces/midra-layout-exchange.md) · [Project format](docs/interfaces/midra-layout.md) · [Plan](docs/midra-layout-plan.md) -- [Development](docs/development.md) · [CI and coverage](docs/ci.md) -- [Cross builds and portable releases](docs/releases.md) · [App icons and desktop launchers](docs/releases.md#application-artwork) -- [MPC-HC Companion module development](companion-modules/media-player-classic/README.md) -- [Future ideas](Ideas.md) -- [Future program task list](docs/program-task-list.md) +| Resource | Links | +| --- | --- | +| Updates | [Per-tool changelogs](docs/changelogs.md) | +| Build and contribute | [Development](docs/development.md) · [CI and coverage](docs/ci.md) · [Cross builds and releases](docs/releases.md) | +| Desktop integration | [App icons and launchers](docs/releases.md#application-artwork) | +| Midra internals | [Project format](docs/interfaces/midra-layout.md) · [Device checks](docs/midra-layout-device-check.md) · [Plan](docs/midra-layout-plan.md) | +| What's next | [Ideas](Ideas.md) · [Program task list](docs/program-task-list.md) |