Skip to content
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

Reformat readme for markdown and reword it #528

Closed
wants to merge 4 commits into from
Closed

Conversation

metov
Copy link

@metov metov commented Jun 20, 2021

The current readme doesn't look very nice on Github (see #475); this PR improves on it:

  • Reformat with Markdown syntax as necessary
  • Add .md extension (otherwise Github will render it as plain text)
    • Do we want to switch other files, like LICENSE, to .md as well for completeness?
  • Reword content to remove some redundant phrasing and formatting

I realize the last point in particular is subjective, so please let me know if my edits are too drastic. I felt that since Markdown formatting opens some possibilities for simplifying the text, I might as well clean it up a little. I can revert those changes and turn it into a pure reformat if the reviewers prefer.

@metov
Copy link
Author

metov commented Jan 31, 2022

Given the amount of time that has passed, and the fact that there are other competing PRs for the same issue, I will close this PR to avoid it going stale. Feel free to reopen if you decide to consider it.

@metov metov closed this Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant