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

Outline motivation/"sales pitch" in README #22

Open
jnormile opened this issue Mar 1, 2024 · 0 comments
Open

Outline motivation/"sales pitch" in README #22

jnormile opened this issue Mar 1, 2024 · 0 comments

Comments

@jnormile
Copy link

jnormile commented Mar 1, 2024

Hey, SEERS team! I know documentation is very much still a work in progress, but I wanted to leave a note about something to keep in mind as you continue to build this out.

In the documentation for the scripts directory, your team included a brief statement about the motivation or the "why" for the content that exists in the directory. I'd like to encourage you all to be sure to include something similar to this on your main page README as well! Make it clear what the use case for your tool is out of the gate, considering what kind of users would benefit from using your tool, or what the proposed utility of your tool is. (Think user stories!)

What you've put together so far is very exciting--just don't forget to communicate that excitement to potential future users looking at your repository!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant