Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

Conversation

agonzalezro
Copy link
Contributor

No description provided.

@garbados
Copy link

The markdown file is actually the one we use to generate the documentation site, while the RST one we generate using Pandoc.

I'd be happy to get us to one authoritative readme, so long as we can still use it to populate the docs.

@garbados garbados closed this Mar 21, 2014
@agonzalezro
Copy link
Contributor Author

I have checked the diff of both files and they look the same. Why you just don't keep the .md insteand the .rst then?

Another option could be a symbolic link (which will be compatible with Linux and Mac boxes, but not with Windows ones)[1].

[1] http://stackoverflow.com/a/954575

@garbados
Copy link

PyPI displays RST in its on-page readmes. Before we had an RST readme, it would display the markdown one, but because PyPI doesn't parse markdown, it looked super raw.

@agonzalezro
Copy link
Contributor Author

Ok. Just trying to give some idea (that doesn't work :D).

Thanks for merging the other one!

@garbados
Copy link

No problem! And thanks for the suggestions, for sure :) I don't know how to solve this problem but I'll leave this issue open for continued discussion.

@garbados garbados reopened this Mar 24, 2014
@agonzalezro
Copy link
Contributor Author

Hi @garbados I will close this PR if you don't mind. Feel free to open it again if it makes any sense.

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

Successfully merging this pull request may close these issues.

2 participants