Compilation

Compilation requires Zig & a macOS, Linux, or Unix-like operating system. Windows is not supported.

Linux

Standard fast build:

zig build --release=fast

For the best performing binary, enable FLTO:

zig build --release=fast -Dflto=true

Note that this can cause library linking issues, but if you plan to use only the binary, this is the best-performing option.

macOS

Standard fast build:

zig build --release=fast

Artifacts

Compilation emits:

zig-out
├── bin
│   ├── fmetrics
├── include
│   └── fmetrics.h
└── lib
    └── libfmetrics.a

fmetrics binary usage is revealed with ./fmetrics --help.

Note: Usage is different per-metric; some metrics support outputting visual error maps via --err-map, and some support additional configuration options. I/O is the same for all metrics, and is provided by simpleimgio.