You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Qix- opened this issue
Dec 19, 2018
· 2 comments
· May be fixed by #937
Labels
change-patchThis proposes or provides a change that requires a patch releasepr-welcomeThis issue has an approved change; a pull request would be appreciated
Debug has a simple API with a handful of static-/member-methods. It has been relatively unchanged since its conception (yes, users of 0.x can most likely upgrade to the latest major without any problems).
However, the README currently reflects a manual (nay, a bible) of integrated examples, etc. for a library that should be easily grok-able in just a few moments' time.
Not every method call needs three examples, nor does it need several paragraphs explaining the intricacies of how the method is useful.
Further, the use of screenshots is egregious. They add several pagefuls of redundant information.
Let's minimize the README to just:
Single screenshot (very top, centered)
Title; summary
Installation
Basic usage
API documentation
Examples
Open Collective et al
License
The text was updated successfully, but these errors were encountered:
Qix-
added
change-patch
This proposes or provides a change that requires a patch release
pr-welcome
This issue has an approved change; a pull request would be appreciated
labels
Dec 19, 2018
change-patchThis proposes or provides a change that requires a patch releasepr-welcomeThis issue has an approved change; a pull request would be appreciated
Debug has a simple API with a handful of static-/member-methods. It has been relatively unchanged since its conception (yes, users of 0.x can most likely upgrade to the latest major without any problems).
However, the README currently reflects a manual (nay, a bible) of integrated examples, etc. for a library that should be easily grok-able in just a few moments' time.
Not every method call needs three examples, nor does it need several paragraphs explaining the intricacies of how the method is useful.
Further, the use of screenshots is egregious. They add several pagefuls of redundant information.
Let's minimize the README to just:
The text was updated successfully, but these errors were encountered: