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 is a copy of the docs and can be simplified. #16

Closed
ocefpaf opened this issue Jun 2, 2019 · 2 comments
Closed

README is a copy of the docs and can be simplified. #16

ocefpaf opened this issue Jun 2, 2019 · 2 comments

Comments

@ocefpaf
Copy link

ocefpaf commented Jun 2, 2019

This is my opinion and not really a PyOpenSci recommendation but README should be straight to the point, with some examples and a quick way to get the package installed.

xref.: pyOpenSci/software-submission#7
@ocefpaf ocefpaf mentioned this issue Jun 2, 2019
Closed
22 tasks
@marskar
Copy link
Collaborator

marskar commented Jun 18, 2019

The docs are built (in-part) from the README.
I simplified and streamlined the docs.
I created a few new sections rather than including everything in the docs.
If you have any suggestions of how to further split things up, please let me know.

@marskar marskar closed this as completed Jun 18, 2019
@ocefpaf
Copy link
Author

ocefpaf commented Jun 18, 2019

If you have any suggestions of how to further split things up, please let me know.

I'll take a second look soon but it looks good to me the way it is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ocefpaf @marskar