docs: rewrite the README, add the logo set, tighten tests - #1
Merged
Merged
Conversation
PHPUnit 13 requires php >= 8.4.1, so requiring it here made composer install insoluble on the 8.3 job: cs, sa and tests all died before running anything. The package supports PHP 8.3 and the matrix tests it. The strictness that came with the bump stays. failOnDeprecation, failOnNotice and failOnEmptyTestSuite are all in the 12.5 schema, so nothing is lost by holding the version back.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three strands, kept as separate commits.
Documentation. The README leads with what the package returns: geometry, never SVG. That boundary is the thing a reader has to understand first. Every
See alsoblock is removed and the cross-links are woven into the prose.Tests. Requires PHPUnit 13 and fails on deprecations and notices.
Assets. Adds the package logo set, tracks the examples the documentation links to, and ignores the generated
examples/output/.100 files.
composer qapasses.