Restructure README to lead with the version control value proposition#32
Merged
Conversation
The README opened with a feature list and never stated the problem CODESCRIBE solves. It now opens with the problem (a .project file is a binary blob git cannot diff, merge or review), the before/after screenshots, and a typical git workflow. Version-specific migration notes move to a new CHANGELOG.md, split into v0.2.0 and Unreleased based on what the v0.2.0 tag actually contains. Also folds in two accuracy gaps: device-tree import semantics (tracked devices removed and recreated, package-fixed devices skipped) and the exported items list now includes GVLs, persistent variable lists and device-tree devices. The toolbar setup step now lists all five scripts.
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.
Summary
The README opened with "CODESYS plaintext import and export scripts." and a feature list, but never stated the problem the tool solves: a CODESYS
.projectfile is a proprietary binary format that git cannot diff, merge or review. This PR restructures the README to lead with that value proposition.CHANGELOG.md, split into v0.2.0 and Unreleased based on what the v0.2.0 tag actually containsLocal_IOandHMIskipped with their configuration carried by the template)Export Lib To FilesDocs only, no source changes.