Every repo should contain a README file, which is a document that describes your project.
A README is the first item a visitor will see when visiting your repo.
Show your Code: Use Github as a Code Portfolio
CIT students can use Github repos as a code portfolio, to showcase the work they’ve done in their CIT courses.
A code portfolio is a useful tool to demonstrate what you’ve learned during the interview process.
Set Up your README for a Code Portfolio
Each project repo you create for your CIT classes should have a README.md file that describes your project.
If you actually deployed the project and it is running on a hosting service such as Heroku, Zeit Now, or Cloud Foundry, then add a link to your README that connects to the web app.
Here’s a template to make good README.md for your CIT Code Portfolio: