WIP: Add first draft of README

fedora-python / python-ethtool

Deprecated Python bindings for the ethtool kernel interface

GNU General Public License v2.0

15 stars 13 forks source link

WIP: Add first draft of README #5

Closed frenzymadness closed 7 years ago

frenzymadness commented 7 years ago

Fix #2

hroncok commented 7 years ago

Some things missing:

[ ] License information
[ ] Example usage
[ ] Mention manpage
[ ] How to run tests (with tox), mention they are broken now

hroncok commented 7 years ago

Especially with project, that has a history with moving upstream, plese always reference issues and pull request in the commit messages with full URLs:

Fix https://github.com/fedora-python/python-ethtool/pull/2

Instead of:

Fix #2

GitHub will show it nicely anyway, but if the repo is moved, the numbers keep making sense.

hroncok commented 7 years ago

Also, since this should end up in long_description and on PyPI, could you please use RST instead of Markdown?

hroncok commented 7 years ago

Closing in favor of https://github.com/fedora-python/python-ethtool/pull/13