Documentation
Guides for using, building and contributing to FrameTrellis. These pages are generated from the Markdown files in the repository, so they always match the code.
Using FrameTrellis
Installation
Installing on Windows, building on Linux, and where data is kept.
User guide
Every feature of the editor, from importing media to exporting.
Supported formats
The media FrameTrellis imports and the files it exports.
Keyboard shortcuts
All shortcuts, also listed in the app.
Rendering in a container
Render projects on a server or in CI with the container image.
Releases
How releases are published and where their notes live.
Unreleased changes
What has changed since the last release.
Building and contributing
Building from source
Build instructions for Windows 11, Linux and macOS.
Distribution channels
Release assets, and the plans for WinGet, Flathub and Homebrew.
Testing
Unit, integration and GUI tests, sanitizers and static analysis.
Contributing
How to report bugs, propose changes and send pull requests.
Code of conduct
The standards of behaviour in the project.
Architecture
Project
Roadmap
Milestones up to version 1.0 and beyond.
Licensing
Why GPL-3.0-or-later, and how it fits Qt, MLT and FFmpeg.
Third-party notices
Components FrameTrellis uses and their licenses.
Security policy
How to report a vulnerability.
Security design
How untrusted projects and media are handled.
Maintainer links
The verified list of the maintainer's profiles.