README: Modernise top-level README.md#490
Open
ArokyaMatthew wants to merge 1 commit intoeclipse-basyx:developfrom
Open
README: Modernise top-level README.md#490ArokyaMatthew wants to merge 1 commit intoeclipse-basyx:developfrom
ArokyaMatthew wants to merge 1 commit intoeclipse-basyx:developfrom
Conversation
The top-level README was sparse compared to other Eclipse BaSyx repositories. This commit rewrites it with structured sections, status badges, specification compliance table (moved to the top), updated server description (Registry and Discovery APIs), tutorials, FAQ, and corrected release schedule reflecting the develop workflow. Changes based on review feedback: - Removed 'Details' column from package overview table - Removed 'Compliance Checking' from SDK features (now a separate package) - Updated server interfaces to include Registry and Discovery APIs - Moved specification compliance to the top of the file - Removed 'Getting Started' section (duplicates sub-package READMEs) - Trimmed FAQ to genuinely asked questions - Updated release schedule to reflect develop-to-main workflow Fixes eclipse-basyx#475
7940734 to
3a14055
Compare
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.
Description
Rewrites the top-level README to give new visitors a clearer picture of what this project does, which specifications it implements, and where to find things.
This is a revised version of #488, rebased onto
developand updated with all review feedback from @s-heppner.Changes from v1 (#488), addressing review feedback
develop(Experimental/registry and discovery server #407).develop, only published states are merged tomain.developinstead ofmain.What's in the new README
Fixes #475
Supersedes #488