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

Example Project In README Should Be Smaller #28

Open
kagoff opened this issue Nov 23, 2020 · 0 comments
Open

Example Project In README Should Be Smaller #28

kagoff opened this issue Nov 23, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@kagoff
Copy link

kagoff commented Nov 23, 2020

While following the README, the user will want to verify if their environment is setup correctly and to view a sample output of the tool. As of now, the example project for this is Flipkart/foxtrot.

This repository is very large and takes a substantial amount of runtime on most systems. This is unnecessary as the user is most likely looking for quick validation.

I recommend using a simpler/smaller example project.

@dtomassi dtomassi added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 23, 2020
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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants