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.

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

Closed
betolink opened this issue May 8, 2024 · 2 comments · Fixed by #579
Closed

README needs "Why earthaccess?" and "one-liner install" #561

betolink opened this issue May 8, 2024 · 2 comments · Fixed by #579
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@betolink
Copy link
Member

betolink commented May 8, 2024

I think the last documentation PR #498 removed too much information from the README, in particular the justification and how to install it.

  • "Why earthaccess?
  • "How to install earthaccess"

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!

@mfisher87 mfisher87 changed the title README README needs more detail May 8, 2024
@mfisher87 mfisher87 added the documentation Improvements or additions to documentation label May 8, 2024
@mfisher87 mfisher87 changed the title README needs more detail README needs "Why earthaccess?" and "one-liner install" May 10, 2024
@Sherwin-14
Copy link
Contributor

@mfisher87 @betolink Hey, do you guys have any specific opinions regarding this? If not, then can I take this issue up?

@mfisher87
Copy link
Member

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 :)

  • "How to install": pip install earthaccess in the existing "How to get started" section, above the "Visit the quick start" paragraph.
  • "Why earthaccess?": Maybe we can re-use the text from "What is earthaccess?"; perhaps just the paragraph starting with "During several workshops"? And maybe that goes in a new section titled "Why earthaccess?" in the README, but I don't have strong feelings about where it should go in the README. Perhaps above "How to get started"?

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
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants