Improve README
Summary
We should greatly improve README.md (at least in core)
Motivation
A big and usefull README.md can improve the first contact with customers.
Detailed Design
We should add updated badges, a logo (see #7), installation guide, ...
Documentation
This is the reduced form of a documentation 🙂
Drawbacks
No.
Alternatives
No.
Open Questions
Any questions?
Help Needed
Yes, we should think/work together on creating an improved README.md.
Frequently Asked Questions
Currently none
Related Discussions
Currently none
Improve README
Summary
We should greatly improve README.md (at least in
core)Motivation
A big and usefull README.md can improve the first contact with customers.
Detailed Design
We should add updated badges, a logo (see #7), installation guide, ...
Documentation
This is the reduced form of a documentation 🙂
Drawbacks
No.
Alternatives
No.
Open Questions
Any questions?
Help Needed
Yes, we should think/work together on creating an improved
README.md.Frequently Asked Questions
Currently none
Related Discussions
Currently none