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

Decouple Readme based on use cases #14

Open
radeksimko opened this issue Mar 11, 2022 · 0 comments
Open

Decouple Readme based on use cases #14

radeksimko opened this issue Mar 11, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@radeksimko
Copy link
Member

I'm not tied to filenames, but from your response we appear to be in agreement that this README should be a landing page and not a catalogue of all the different sets of knowledge required to use the files in this repo.

Extrapolating from your thoughts, I think we need:

  • README.md with sections briefly explaining the repo and the different types of uses cases. Each with links to get users/contributors where they need to go.
  • USAGE.md document outlining expected ways to consume these files
  • CONTRIBUTING.md document outlining what content we accept.

Originally posted by @jpogran in #11 (comment)

@radeksimko radeksimko added the documentation Improvements or additions to documentation label Mar 23, 2022
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
None yet
Development

No branches or pull requests

1 participant