Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document how to use the tools in README.md #3

Open
Rangi42 opened this issue Oct 7, 2024 · 0 comments
Open

Document how to use the tools in README.md #3

Rangi42 opened this issue Oct 7, 2024 · 0 comments

Comments

@Rangi42
Copy link
Member

Rangi42 commented Oct 7, 2024

It's not always intuitive or easy to browse a directory full of script code and see what they're for. The README.md should have a subheading for each tool, with a brief explanation/example of how it's used.
@Rangi42 Rangi42 changed the title Document how to use the tools Document how to use the tools in README.md Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Rangi42