docs: add images & fix typo

This commit is contained in:
technofab 2025-06-08 20:52:20 +02:00
parent b732e118df
commit 6ee3811b56
No known key found for this signature in database
5 changed files with 7 additions and 1 deletions

View file

@ -9,12 +9,16 @@
Flexible test runner for testing Nix code, written in Go.
[![asciicast](https://asciinema.org/a/VS8uIiEQiPRtXbOreJqrxO7X6.svg)](https://asciinema.org/a/VS8uIiEQiPRtXbOreJqrxO7X6)
## Features
- Snapshot, Unit (equal checks) and Script-Tests (unit tests with assertions you could say)
- Supports testing against raw Nix code or derivation output
- Simple and easy to read summary of test results
![screenshot](./docs/images/summary_screenshot.png)
- Junit report support (eg. for displaying the results in GitLab etc.)
![screenshot](./docs/images/gitlab_junit_screenshot.png)
## Usage

Binary file not shown.

After

Width:  |  Height:  |  Size: 173 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

View file

@ -7,4 +7,6 @@ Flexible test runner for testing Nix code, written in Go.
- Snapshot, Unit (equal checks) and Script-Tests (unit tests with assertions you could say)
- Supports testing against raw Nix code or derivation output
- Simple and easy to read summary of test results
![screenshot](./images/summary_screenshot.png)
- Junit report support (eg. for displaying the results in GitLab etc.)
![screenshot](./images/gitlab_junit_screenshot.png)

View file

@ -93,7 +93,7 @@ Examples:
name = "pretty-test";
# by default it uses json to serialize and compare the values. Derivations
# and functions don't really work that way though, so you can also use
# "pretty" to use lib.generators.pretty
# "pretty" to use lib.generators.toPretty
format = "pretty";
# you can also set the pos here
pos = __curPos;