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

Update Read Me #169

Open
aplymill7 opened this issue Apr 19, 2021 · 0 comments
Open

Update Read Me #169

aplymill7 opened this issue Apr 19, 2021 · 0 comments
Labels
documentation Explains how the code works or how to use it

Comments

@aplymill7
Copy link
Member

The ReadMe file should be updated to have an inclusive description to point potential users in the right direction. The updated read me file should perform the following:

  1. Summarize the program
  2. Point to docs (html, how to build, or io page)
  3. Within docs point to installation/operation guide
  4. Point to hardware, software, Github admins contact for questions
  5. Point to contributing guidelines if they want to contribute to the project
@aplymill7 aplymill7 added the documentation Explains how the code works or how to use it label Apr 19, 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 Explains how the code works or how to use it
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@aplymill7