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:
Summarize the program
Point to docs (html, how to build, or io page)
Within docs point to installation/operation guide
Point to hardware, software, Github admins contact for questions
Point to contributing guidelines if they want to contribute to the project
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: