# Tytanic
`tytanic` is a test runner for [Typst] projects.
It helps you worry less about regressions and speeds up your development.

## Features
Out of the box `tytanic` supports the following features:
- compile and compare tests
- manage tests of various types
- manage and update reference documents when tests change
- filter tests effectively for concise test runs

[![An asciicast showing tytanic running the full cetz test suite.][demo-thumb]][demo]

## Documentation
To see how to get started with `tytanic`, check out the [book].

## Contribution
[CONTRIBUTING.md][contrib] contains some guidelines for contributing.

## Changelog
The changelog can be found [here][changelog].

## License
Tytanic is dual-licensed under MIT or Apache 2.0 (`SPDX-License-Identifier: MIT OR Apache-2.0`).

[contrib]: ./docs/CONTRIBUTING.md
[changelog]: ./docs/CHANGELOG.md

[Typst]: https://typst.app
[book]: https://typst-community.github.io/tytanic/index.html

[demo-thumb]: https://asciinema.org/a/rW9HGUBbtBnmkSddgbKb7hRlI.svg
[demo]: https://asciinema.org/a/rW9HGUBbtBnmkSddgbKb7hRlI
