Update README.md #1
Open
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
First-pass suggestions
Mirroring of the SPM org as a model. Some further tightening.
Contributor
Author
|
Aside from permissions and such: requesting @tiborauer as a reviewer |
tiborauer
approved these changes
Jan 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This contains my first-pass suggestions of how the README could be evolved to summarize succinctly in the top couple of sentences.
I plan a second pass later this week to think about tweaks on the subsequent paragraphs (including their headings).
Note that for the Org overall, one model I have in mind is the SPM org. As shown below, they use an acronym as the title and then spells it out in the subtitle. I have in mind to do the same (can put in request to Pradeep at INCF) and that enables assuming the acronyms are defined for the README headline.