-
Notifications
You must be signed in to change notification settings - Fork 7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
migrate README to markdown #7565
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/vision/7565
Note: Links to docs will display an error until the docs builds have been completed. ❌ 1 New Failure, 1 PendingAs of commit 52dd3af: This comment was automatically generated by Dr. CI and updates every 15 minutes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the reason this is a rst
file comes from the good old days when PyPI didn't support markdown (and IIRC GitHub didn't support rst for README. Good times).
Anyway, IMHO this is a very marginal improvement but I don't have a strong opinion so I'll approve to unblock. FYI, the collapsed table is formatted as "raw" - not sure if this is intended.
Nope, not intended. |
Hey @pmeier! You merged this PR, but no labels were added. The list of valid labels is available at https://github.com/pytorch/vision/blob/main/.github/process_commit.py |
Reviewed By: vmoens Differential Revision: D45694878 fbshipit-source-id: d3fa448ee30adeb884ae38cc65cca72fcd96a3f1
It always bugged me that we had our README in rst rather than in markdown. This usually is only done in case we need to pull this into our sphinx documentation. But this is not the case here. Thus, I've aligned the README with all of our other files and migrated it to markdown.
This PR is a 1-to-1 port except for two changes:
Rendered README.md