Repository navigation
docs: polish README for release - #3
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the README to prioritize end-user setup information before development and contributor details, making the project documentation more release-oriented.
Changes:
- Adds user-facing Requirements, Installation, Configuration, and log location sections near the top.
- Consolidates Linux/Windows build and contributor setup under Development.
- Moves CI, Nexus upload, credits, and inspirations toward the bottom.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Restructures README with user-facing content first (requirements, installation, configuration) followed by developer/contributor sections, with credits and inspirations at the bottom.