Week 07 - Day 1 - Spit and Polish

[gstark]

Your GitHub repository will be part of your portfolio and you will likely link to it from your portfolio.

Creating a clean looking README is as important for a project as having nice clean code.

Here are some examples of great READMEs:

• https://github.com/axios/axios
• https://github.com/Microsoft/vscode
• https://github.com/twbs/bootstrap
• https://github.com/electron/electron

Here are some example of great student READMEs:

• https://github.com/cfsanderson/Minesweeper
• https://github.com/m1g/tic-react-toe
• https://github.com/m1g/snowman

Objectives

• Create quality READMEs

Explorer Mode

• [ ] Choose several (at least three) repositories to update the READMEs
• [ ] Include a description, in your own words, of what the assignment was
• [ ] Include a list of technologies (and links to the homepage for each) you used
• [ ] Include a link to the project in production (surge, etc.)
• [ ] Include a screenshot or an animated gif (see https://github.com/wulkano/kap or http://recordit.co/ or https://www.cockos.com/licecap/)
• Optional:
  • [ ] Include an aspect you are particularly proud of
  • [ ] Include a snippet of code you are proud of (see GitHub Markdown on how to format code snippets)

[JOLee83]

https://github.com/JOLee83/minesweeper/blob/master/README.md https://github.com/JOLee83/black-jack/blob/master/README.md https://github.com/JOLee83/roshambo/blob/master/README.md