⚠️ Obsolete — the SVT Encore documentation has moved

This repository is no longer maintained and its contents are outdated.

The SVT Encore documentation now lives at https://svt.github.io/encore/, built from the encore repository.

Please update your bookmarks. The old site at https://svt.github.io/encore-doc/ now redirects to the new documentation.

---

SVT Encore Documentation

Welcome to the SVT Encore documentation project. It is mainly aimed at advanced technical users, like developers.

SVT Encore is a scalable tool for video transcoding,

The documentation has moved — see the current online documentation. The content below is kept for historical reference only and is no longer updated.

Development

Clone the project with git. Build the documentation by invoking the 'asciidoctor' goal:

foo@bar:~$./gradlew clean asciidoctor

View the generated documentation in a browser of choice, for example

foo@bar:~$firefox build/docs/asciidoc/index.html

Requirements

• Gradle 7.x.x

• Optional: Intellij with the Asciidoctor Plugin

Optional for development: IntelliJ Plugin

Install the Asciidoctor plugin and get writing, with a preview window, export to HTML, PDF and more. It is great actually.

License

This documentation is

• Copyright 2021 Sveriges Television AB

and released under

Creative Commons Attribution-ShareAlike 4.0 International License

Note: The main project SVT Encore itself was initiated in 2018.

Credits

• Write The Docs and everyone driving the Docs-As-Code philosophy, thanks.

• Asciidoctor skins project

• Highlights