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

Rename README to README.md #11

Closed
wants to merge 1 commit into from
Closed

Conversation

davelab6
Copy link

@davelab6 davelab6 commented Apr 14, 2017

This enables inline github rendering of the markdown syntax used

You can see how it looks here:

https://github.com/davelab6/harfpy/tree/patch-1

@ldo
Copy link
Owner

ldo commented Apr 14, 2017

It is traditional for README to be called README, not README.md. Think of the latter as a GitHubism. I don’t want to tie my development too closely into GitHub!

@ldo ldo closed this Apr 14, 2017
@davelab6
Copy link
Author

But your file is written in markdown; its general best practice to use a file extension that expresses the contents of the file

@ldo
Copy link
Owner

ldo commented Apr 14, 2017

Markdown is just text. It is meant to be human-readable as is.

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

2 participants