Skip to content

Enhancement: Update Readme to allow for replicable results #2

@gtcha2

Description

@gtcha2

Problem

README file does not have instructions on how to run or use.
This is also important for replication of errors or successes.

Proposed Improvement

README UPDATES

  1. Include requirements and env set up
  2. Include instructions to do so from command line or with someone else's api key for gcp.
  3. This will also require a top level main file with argument parsing or a bash script that does this..

Priority

Highest priority in the list is just instructions on how to start from nothing to this env from cloning to run.

Validation comes from if an external user can spin up the code in a reasonable time without modifying or changing the internals.

Additional Information

No response

Code Guidelines

  • I agree to follow the Coding Guidelines for this project

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions