Update README.md #78
Update README.md #78
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the README.md file to improve the project description. The main change corrects the hyphenation of "Python-based" and attempts to add a repository reference with a badge/image link.
- Fixes grammar by adding hyphen to "Python-based"
- Adds text and image link referencing the GitHub repository
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| #  PIVPy | ||
|
|
||
| Python based post-processing PIV data analysis | ||
| Python-based post-processing PIV data analysis in the repo: https://github.com/openpiv/pivpy |
There was a problem hiding this comment.
The added text "in the repo:" followed by a badge/image link is unclear and confusing. The phrase suggests the badge represents the repository itself, but the syntax used is for displaying an image/badge, not a standard link. Consider either:
- Using a proper markdown link: "Python-based post-processing PIV data analysis. See PIVPY"
- Or if this is meant to be a badge, ensure the URL points to an actual image resource, not the GitHub repository homepage
| Python-based post-processing PIV data analysis in the repo: https://github.com/openpiv/pivpy | |
| Python-based post-processing PIV data analysis. See [PIVPy](https://github.com/openpiv/pivpy). |
| #  PIVPy | ||
|
|
||
| Python based post-processing PIV data analysis | ||
| Python-based post-processing PIV data analysis in the repo: https://github.com/openpiv/pivpy |
There was a problem hiding this comment.
The image alt text "PIVPY" is inconsistent with the logo alt text "PIVPy" on line 4. The casing should be consistent throughout the README. Consider using "PIVPy" (with lowercase 'y') to match the established naming convention.
No description provided.