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

Make README say what the point of this is/show example output #36

Open
davidlmobley opened this issue Dec 17, 2021 · 0 comments
Open

Make README say what the point of this is/show example output #36

davidlmobley opened this issue Dec 17, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
0.3.0 release

Comments

@davidlmobley
Copy link

Popped on here to point this out to someone, and noticed the README does not:
a) lead with a summary of what the point of this package is/what it's for
b) show examples of what is generated (example plots or analysis)
c) really state any conclusions or recommendations
d) Link to the benchmarking best practices paper

Perhaps these can be quickly addressed?
@IAlibay IAlibay added the documentation Improvements or additions to documentation label May 17, 2022
@IAlibay IAlibay added this to the 0.3.0 release milestone May 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.3.0 release
Development

No branches or pull requests
2 participants
@davidlmobley @IAlibay