What is a ReadMe?
A README file is a text file containing information for the user about the software program, utility, or game. README files typically contain instructions and additional help as well as details about patchesor updates.
A ReadMe outlines:
- What the project does
- Why the project is useful
- How users can get started with the project
- Where users can get help with your project
- Who maintains and contributes to the project
The professionals within my career goals will know the link to my website
A lot of jobs and recruitment nowadays is online and upon any requests, I could create a ReadMe file for my portfolio but it is not necessary at this moment in time. A link to my portfolio could be placed on various social media platforms and my CV which will help clients/employers seek the work I have created and send them straight to the portfolio.
References
Inc, G. (2017a) About READMEs – user documentation. Available at: https://help.github.com/articles/about-readmes/ (Accessed: 3 March 2017).
Inc, G. (2017b) About READMEs – user documentation. Available at:
https://help.github.com/articles/about-readmes/ (Accessed: 3 March 2017).
Advertisements
