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

Adding markdown formatted README #57

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

orenfromberg
Copy link

what is this?

This branch adds a README.md file that is a markdown formatted version of the existing README file.

why

The benefit of using markdown is that GitHub can render syntax highlighting for python and bash script, as well as format the documentation in a responsive way for mobile browsers.

requested feedback

  • should the existing README be removed?

@rescrv
Copy link
Owner

rescrv commented Feb 19, 2021

I don't remember if it was this repository or another where I explained the reason I don't do a README.md as opposed to a README is it gives me flexibility to just write without having to keep a different flavor of markdown in my mind for each service that uses it. I would be willing to accept the other patches and/or a convincing discussion about the marrkdown.I belive it's this repo where the README is parsed as is to create some tests.

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.

2 participants