Convert README format from reStructuredText to markdown #357
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
Markdown is much easier to manage and more GitHub compatible.
There was a problem hiding this comment.
Pull Request Overview
This PR converts the project’s README from reStructuredText to Markdown for easier editing and better GitHub support.
- Updated references in setup scripts to use README.md
- Deleted the old README.rst
- Added a new README.md in Markdown format
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| setup.py | Changed long_desc file open call from README.rst to README.md |
| setup.cfg | Updated description_file to point at README.md |
| README.rst | Removed old reStructuredText documentation |
| README.md | Added new Markdown README |
Comments suppressed due to low confidence (1)
README.md:26
- [nitpick] Consider rephrasing this to 'Documentation for
xmlseccan be found at...' for improved clarity.
A documentation for `xmlsec` can be found at
mxamin
force-pushed
the
cleanup/convert-readme-to-markdown
branch
from
21e47b0 to
58df45c
Compare
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.
Markdown is much easier to manage and more GitHub compatible.