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

README.md? #330

Closed
jGaboardi opened this issue Jul 28, 2020 · 2 comments · Fixed by #598
Closed

README.md? #330

jGaboardi opened this issue Jul 28, 2020 · 2 comments · Fixed by #598
Assignees

Comments

@jGaboardi
Copy link
Member

Should the README.rst be swapped out for a README.md?

@jGaboardi jGaboardi self-assigned this Jul 28, 2020
@jGaboardi
Copy link
Member Author

Looking back at this. Is there a reason to keep the README as an .rst file? If we follow #594, then we should probably standardize to a .md.

cc @knaaptime @martinfleis @sjsrey

@martinfleis
Copy link
Member

It should be md in my opinion. I don't think our tooling cares but markdown should always be preferred unless we need some specific RST stuff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants