Skip to content

Treegen.py #3

@Ananya-vastare

Description

@Ananya-vastare

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.md includes the treegen.py utility 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

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