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

Feature Request: README and About description #1

Open
nelsonni opened this issue Dec 18, 2021 · 0 comments
Open

Feature Request: README and About description #1

nelsonni opened this issue Dec 18, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@nelsonni
Copy link
Member

Instead of storing the documentation in a Word (.docx) file, migrating to a README file will surface the information within GitHub and allow everyone to quickly understand what this package offers and what is required to run it.

Similarly, adding an About description for the repository would allow for quickly reading and understanding the purpose of the repo. The About is currently empty:
Screen Shot 2021-12-18 at 11 55 26 AM
@nelsonni nelsonni added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nelsonni