-
Notifications
You must be signed in to change notification settings - Fork 92
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.
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
README needs "Why earthaccess?" and "one-liner install" #561
Labels
impact: documentation
Improvements or additions to documentation
Comments
mfisher87
added
the
impact: documentation
Improvements or additions to documentation
label
May 8, 2024
mfisher87
changed the title
README needs more detail
README needs "Why earthaccess?" and "one-liner install"
May 10, 2024
@mfisher87 @betolink Hey, do you guys have any specific opinions regarding this? If not, then can I take this issue up? |
Hey @Sherwin-14 it would be great if you'd be willing to start on this! Some opinions, not sure if @betolink agrees or not :)
|
Sherwin-14
added a commit
to Sherwin-14/earthaccess
that referenced
this issue
May 18, 2024
Sherwin-14
added a commit
to Sherwin-14/earthaccess
that referenced
this issue
May 18, 2024
Sherwin-14
added a commit
to Sherwin-14/earthaccess
that referenced
this issue
May 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I think the last documentation PR #498 removed too much information from the README, in particular the justification and how to install it.
We should try to have one source of true but people usually see a README and expect to get a sense of what the project is about (context) and some basic instructions (how to install it and perhaps an example). I think this is related to how well-known a project is, once that a project gets big enough they prioritize external docs (even with their own domains like https://docs.xarray.dev/en/stable/) but I feel like until we are at that level maybe we should not forget that a README is the first point of entry to a library. Some of the concepts I find relevant come from Art of README
I'm happy to discuss this further!
The text was updated successfully, but these errors were encountered: