Rename README to README.md

paulc / dnslib

A Python library to encode/decode DNS wire-format packets

https://github.com/paulc/dnslib

BSD 2-Clause "Simplified" License

295 stars 84 forks source link

Rename README to README.md #49

Closed rmbolger closed 6 months ago

rmbolger commented 1 year ago

This change simply renames README to README.md so Github will render the markdown nicely on the repo homepage.

rmbolger commented 6 months ago

Doesn't setup.py only run at install time on the end user's system? So changing it there wouldn't affect what gets committed to the git repo?

nhairs commented 6 months ago

Actually it looks like I'm partially mistaken. You'd need to update both the README and setup.py files.

setup.py is somewhat multi-purpose. It will be used in on the "local" machine in source distribution installation, but it can also be used by the maintainer to build wheel or other distributions. Reading the comments at the top of the file it appears it is also being used to generate the README from the package's docstring.

paulc commented 6 months ago

Thanks - I've just added a symbolic-link from README -> README.md which seems to fix the problem (and requires minimal changes)

rmbolger commented 6 months ago

Nice. I didn't even realize that was possible.