Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clean up README #649

Open
Qix- opened this issue Dec 19, 2018 · 2 comments · May be fixed by #937
Open

Clean up README #649

Qix- opened this issue Dec 19, 2018 · 2 comments · May be fixed by #937
Labels
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
Milestone
5.x

Comments

@Qix-
Copy link
Member

Qix- commented Dec 19, 2018

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
@Qix- 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
@Qix- Qix- added this to the 5.x milestone Dec 19, 2018
This was referenced Dec 19, 2018
Closed
Open
Open
@RabiaSaid
Copy link

2.6.8

@RabiaSaid
Copy link

4.3.4

@brandonjfeldkamp brandonjfeldkamp linked a pull request Jul 20, 2023 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
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
Milestone
5.x
Development

Successfully merging a pull request may close this issue.

clean up readme brandonjfeldkamp/debug
2 participants
@Qix- @RabiaSaid