Adding markdown formatted README #57
Open
+643
−0
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
Owner
|
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
2 participants
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.
what is this?
This branch adds a
README.mdfile that is a markdown formatted version of the existingREADMEfile.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
READMEbe removed?