Repository navigation
docs(readme): align on the shared project README structure - #4
Merged
Merged
Conversation
Usage, Xdebug, JetBrains, local build and pipeline move to docs/SETUP.md.
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
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.
What
Rewrites README.md on the shared project structure (description, CI and Publish badges, Stack, Documentation, Quick start, What's included, Commands, Environments, Workflow).
Why
Every tekalib and brei0x project README should read the same way, with CI and publish status in the header.
How
Usage recipes, updating, other platform, Xdebug and JetBrains setup, local build and the pipeline move verbatim to a new docs/SETUP.md. The tags table becomes the Environments table.
Tests
Docs only. CI runs on this PR.
Risk
None at runtime. Readers who knew the JetBrains section in the README now find it in docs/SETUP.md, linked from the Documentation table.
Rollback
Revert the squash commit.