Skip to content

Docs: Add basic running example for script beginners #3323

Description

@minzhenw490-pixel

Documentation Improvement Suggestion

Problem Description

The repository README only introduces how to clone and install the project, but there is no specific running demonstration for any script. New Python learners don’t know how to execute the sample scripts after downloading the repo.

Suggested Optimization

Add a general running guide under Quick Start section:

  1. Enter the corresponding script folder
  2. Run the script with command:
python script_name.py

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions