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

README update #58

Open
seabbs opened this issue May 14, 2020 · 0 comments
Open

README update #58

seabbs opened this issue May 14, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@seabbs
Copy link
Contributor

seabbs commented May 14, 2020

As we move to finalise the package it makes sense to remove the warning and improve the documentation. A sensible starting point would be to add a first paragraph that contains the information required by the JOSS guidelines.
@seabbs seabbs added documentation Improvements or additions to documentation help wanted Extra attention is needed labels May 14, 2020
@seabbs seabbs changed the title README overview README overall May 14, 2020
@seabbs seabbs changed the title README overall README update May 14, 2020
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 help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@seabbs