Skip to content

Example Project In README Should Be Smaller #28

Description

@kagoff

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions