Skip to content
Snippets Groups Projects
Pekka Paalanen's avatar
Pekka Paalanen authored
Having an SMPTE spec in the middle of a list of ITU-R specs looked
strange. It is in the right place though, so mention the BT.1700 it
links to.

Signed-off-by: default avatarPekka Paalanen <pekka.paalanen@collabora.com>
65322d15
History

Color management and HDR documentation for FOSS graphics

Documentation in this repository is intended to help with the design and implementation of color management and HDR support on FOSS graphics stacks, including Mesa (EGL, Vulkan WSI), Linux (DRM KMS), Wayland (compositors and applications), and even X11.

This is not an archive of proprietary documents like SMPTE, ITU, or VESA specifications. All content must follow the license.

Contents

History

Originally this documentation was started to better explain how Wayland color management extension should be used and what it means.

Widening community interests particularly in HDR prompted for moving the documentation into this separate repository to allow a more streamlined way of contributing to it.

For now, this project lives in a personal space, but if it gets more traction, moving it into an independent GitLab group is possible without losing any Issues or MRs.

Releases

No releases are made from this repository. Use date or the git hash to refer to specific revisions of the contents.

Contributing

Open Issues and Merge Requests in GitLab as usual. Use your own forked repository for MR branches (@pq is exempt as long as this repository is hosted in their personal GitLab group). Each commit must carry Signed-off-by tag to denote that the submitter adheres to Developer Certificate of Origin 1.1.

All merge requests need to be accepted by at least one other person with Developer or higher access level.

Reporter level access can be given by invite without any particular requirements.

Developer access can be given on request, provided the person is actively participating in discussions and has contributed an accepted MR.

Maintainer access is given on Maintainers' collective discretion.

Formatting

New content should use GitLab Flavored Markdown (GLFM). We try to stick to a few formatting rules, but they can be broken when there is a good reason to do so:

  • the same header everywhere (SPDX information, a link to the front page and a Table of Content where appropriate)
  • 80 characters line limit
  • two newlines before headings of level 1 or 2, a single newline otherwise
  • use of reference-style links where appropriate to not break the flow
  • link references always at the end of a section

We enforce those Markdown formatting rules using a linter, use Vale to find issues with prose and a link checker to make sure all links are reachable.

To check for any issues locally, install podman and run the run-check.sh script.

Images

Please, also contribute the "sources" (e.g. SVG) of images if reasonable, even when the image used by the document is an exported one, e.g. PNG.

Writing mathematics

If you want to typeset mathematics, use GLFM and its mathematics support. It uses KaTeX which supports a subset of LaTeX.

KaTeX demo may be helpful for polishing your markup without needing to push to and view in GitLab all the time.

Conduct

This project follows the freedesktop.org Contributor Covenant.