-
Notifications
You must be signed in to change notification settings - Fork 9
Open
Description
name: Add treegen.py utility to README
about: Include the new treegen.py script in documentation with usage instructions
title: " Add treegen.py to README"
labels: enhancement, good first issue
assignees: ''
Description
We’ve added a new utility treegen.py to generate directory tree visualizations in text. We should update the README to document this tool so users know how to use it.
Why
- Makes the tool discoverable and user-friendly
- Encourages use and testing
- Complements the existing docs
Tasks
-
Add a "Utilities" or "Tools" section in
README.md -
Insert an entry for
treegen.py:treegen.py
A simple script to print the directory structure in plain text.
Usage:
python treegen.py /path/to/directory [max_depth]
yaml
Copy
Edit -
Add a concise one-liner and example in the README list
-
(Optional) Add a note on how to run the script (e.g.,
chmod +x treegen.py)
Acceptance Criteria
README.mdincludes thetreegen.pyutility under a clear section- Usage example is formatted correctly and works when copied
- Running the example prints a proper directory tree
References
See other tools in the README for styling and formatting guidelines.
Metadata
Metadata
Assignees
Labels
No labels