mltframework / mltframework/mlt_web

Docs: add a headless / macOS rendering guide to guides/

Open
#9 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
6
Forks
9
PR merge metrics
No merged PRs in 30d

Description

The guides/ directory has a WindowsBuild.md but no equivalent for macOS, and nothing that covers running melt headless (no GUI, for batch/automated rendering). That's a real gap for anyone driving MLT from a server or a script.

I run headless melt on Apple Silicon daily as the render engine behind an automated video pipeline, and I've written down the parts that took time to work out. I'd be glad to contribute a tested guides/HeadlessRenderingMacOS.md covering:

  • building/installing MLT on macOS (Homebrew + Apple Silicon notes)
  • running melt with no display — the flags that actually matter for unattended/batch renders
  • automated progress reporting (-progress2) for scripts and CI
  • the one gotcha that bites people: use the pango producer for titles in a headless context rather than the drawtext/dynamictext path

I'd link it from Documentation.md alongside the Windows guide. Happy to open a PR — just wanted a nod on the scope and title first, and to confirm you'd want it under guides/ rather than developers/.

Thanks for MLT — it's load-bearing for what I build.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading guides/WindowsBuild.md for the existing guide structure and Documentation.md for the navigation link. Verify the documented macOS and Apple Silicon setup and headless melt workflow, including -progress2 and the pango title-producer note; done means adding guides/HeadlessRenderingMacOS.md and linking it alongside the Windows guide.

Written by the indexing model from the issue text.

Assessment

Tech stack
macos
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.