Readme refactoring #113
Readme refactoring #113
Conversation
mottosso
force-pushed
the
readme_refactoring
branch
from
2e3d3b5
to
de2e565
Compare
|
|
||
| - [Development goals](#development-goals) | ||
| - [Support co-existence](#support-co-existence) | ||
| - [Don't get smart](#dont-get-smart) |
There was a problem hiding this comment.
Don't get smart
I personally think it sounds a little condescending. Perhaps change it into "Simplicity"?
There was a problem hiding this comment.
It was "simplicity" at first, but I found it too generic. Everyone aims for simplicity.
- "Don't get clever"?
- "Keep it simple"? (This one is borderline, but better than "simplicity" I guess)
|
Great work! Looking through this now. |
| Qt.py was born in the film and visual effects industry to address the growing needs for the development of software capable of running with more than one flavour of the Qt bindings for Python - PySide, PySide2, PyQt4 and PyQt5. | ||
|
|
||
| 1. **Support co-existence** - Qt.py should not affect other bindings running in same interpreter session. | ||
| 1. **Don't get smart** - One file, copy/paste installation, keep it simple. |
There was a problem hiding this comment.
Don't get smart
Yeah, I'm not too fond of this expression I guess :)
|
LGTM! 👍 🍻 |
|
Thanks Fredrik, good points! Let me know if this takes care of things. |
|
Ok, I had this idea. Keeping the README for the end-user, and CONTRIBUTING for the contributer. What do you think? We can iterate on the goals themselves as they become more clear to us. |
Looks great! 👍
Sure, sounds good. The simpler the README is, the better. Then when you need more info you can dive into CONTRIBUTING. |
|
Ok, let's go with it and adjust as we go! |
Let me know what you think.