Generate and update src/README.md files for each exercise with commands to run Python entry point scripts using uv run from the repo root.
Guidelines for generating and updating the src/README.md file for each exercise.
The src/README.md file in each ExerciseX.Y/src/ directory should contain instructions and commands to run the Python scripts in that exercise using uv run from the repository root.
1. Identify Runnable Scripts
For each exercise directory, identify which Python scripts have if __name__ == "__main__": blocks (entry points).
These are the scripts that should be documented with run commands.
2. Extract Script Information
For each runnable script:
main() function signature to get available parameters3. Format Commands
All commands must follow the format:
uv run python ExerciseX.Y/src/script_name.py [options]
Where:
--parameter=value format4. Update Strategy
When updating an existing src/README.md:
if __name__ block was removed, delete that section5. File Structure
# [Exercise Name] - Running the Code
## [Script Name]
Brief description of what the script does.
### Default run
\`\`\`bash
uv run python ExerciseX.Y/src/script_name.py
\`\`\`
### With custom parameters
\`\`\`bash
uv run python ExerciseX.Y/src/script_name.py --param1=value --param2=value
\`\`\`
**Available Parameters**:
- `--param1`: Description (default: value)
- `--param2`: Description (default: value)
---
## [Next Script Name]
...
Before finalizing src/README.md:
uv run