Improve Readme #44
Merged
Improve Readme #44
Conversation
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
Collaborator
PolarGoose
commented
Dec 2, 2025
PolarGoose
commented
- Add a reference to PlatformIO package
- Improve "How to work with the code" section
There was a problem hiding this comment.
Pull request overview
This PR improves the README.md documentation by adding a concrete PlatformIO package reference and enhancing the developer workflow section. The changes make the documentation more actionable and user-friendly.
Key changes:
- Replaced the TODO placeholder with an actual PlatformIO registry link for the library
- Enhanced the "How to work with the code" section with clearer instructions and better structure
- Removed redundant historical context that was already covered elsewhere in the document
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
PolarGoose
force-pushed
the
improve_readme
branch
from
d746d68 to
291d728
Compare
* Add a reference to PlatformIO package * Improve "How to work with the code" section Improve `build-win.ps1` script: * Add `-SkipAutomaticLocation` flag to `Launch-VsDevShell.ps1` to not change the current directory.
PolarGoose
force-pushed
the
improve_readme
branch
from
291d728 to
16f0920
Compare
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.