···11-# Checkmate - A flake checker (treefmt & nix-unit) for testing other flakes with zero dependencies.
11+<p align="right">
22+ <a href="https://github.com/sponsors/vic"><img src="https://img.shields.io/badge/sponsor-vic-white?logo=githubsponsors&logoColor=white&labelColor=%23FF0000" alt="Sponsor Vic"/>
33+ </a>
44+ <a href="https://vic.github.io/dendrix/Dendritic-Ecosystem.html#vics-dendritic-libraries"> <img src="https://img.shields.io/badge/Dendritic-Nix-informational?logo=nixos&logoColor=white" alt="Dendritic Nix"/> </a>
55+ <a href="LICENSE"> <img src="https://img.shields.io/github/license/vic/checkmate" alt="License"/> </a>
66+ <a href="https://github.com/vic/checkmate/actions">
77+ <img src="https://github.com/vic/checkmate/actions/workflows/test.yml/badge.svg" alt="CI Status"/> </a>
88+</p>
2933-Checks include:
1010+# Checkmate - A Dendritic flake checker (treefmt & nix-unit) for testing other flakes with zero dependencies.
1111+1212+> `checkmate` and [vic](https://bsky.app/profile/oeiuwq.bsky.social)'s [dendritic libs](https://vic.github.io/dendrix/Dendritic-Ecosystem.html#vics-dendritic-libraries) made for you with Love++ and AI--. If you like my work, consider [sponsoring](https://github.com/sponsors/vic)
1313+1414+### Checks included by default
415516- treefmt - nixfmt, deadnix, mdformat, yamlfmt. See `treefmt.nix`.
617718- nix-unit - The flake being checked (ie, `inputs.target`) is expected to expose `flakeModules.checkmate`:
81999-> See [import-tree](https://github.com/vic/import-tree/blob/main/checks/checkmate.nix) or [example](https://github.com/vic/checkmate/blob/main/example/checkmate.nix)
2020+### Extensible.
2121+2222+Checkmate is a collection of Denritic modules.
2323+2424+### Getting started
10251126```shell
1227# Generate a new project including github CI action
1328nix flake new -t github:vic/checkmate
1429```
15303131+### Running flake check locally
3232+3333+```console
3434+nix flake check github:vic/checkmate --override-input target .
3535+```
3636+1637### Running treefmt on your code
17381818-```shell
3939+```console
1940# formatting your code
2020-nix run path:checkmate#fmt
4141+nix run github:vic/checkmate#fmt --override-input target .
21422243# checking if code is formatted
2323-nix run path:checkmate#fmt -- --ci
2424-```
2525-2626-### Running flake check locally
2727-2828-```shell
2929-nix run path:checkmate
4444+nix run github:vic/checkmate#fmt --override-input target . -- --ci
3045```
31463247### CI Usage