Skip to content

Improve README - #17

Merged
rpost merged 7 commits into
mainfrom
readme-improvements
Oct 20, 2026
Merged

rpost merged 7 commits into
mainfrom
readme-improvements

Conversation

@bwaldvogel

Copy link
Copy Markdown
Contributor
  • Fix grammar and spelling
  • Fix wrong output directory (data/test/actual → data/test/output) and configuration interface name (Configure → Configuration)
  • Simplify the title and restructure "Quickstart" as numbered "Getting started" steps, with the Gradle snippet in Kotlin DSL
  • Document previously undocumented features and practices:
    • Gradle integration: test task inputs/outputs for up-to-date checks and the build cache, cleanup of output files, IntelliJ excludes
    • Normalization with ValidationNormalizer, including a note on determinism
    • MarkdownTable

@bwaldvogel
bwaldvogel requested a review from rpost October 18, 2026 08:54

@rpost rpost left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@rpost
rpost merged commit 53adb19 into main Oct 20, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants