issues
search
BeyondCodeBootcamp
/
beyondcodebootcamp
https://beyondcodebootcamp.com
61
stars
3
forks
source link
Great README examples (documentation, markdown)
#11
Open
coolaj86
opened
3 years ago
coolaj86
commented
3 years ago
What should a README be?
Projects should have READMEs that have
Easy to understand the purpose
At-a-glance visual usage / demo
Actual demo
Easy deploy instructions
Great READMEs
Print-to-PDF HTML Resume
Markdown Slides
XTZ.js
mssql-to-csv
README Template
Master Markdown
(honestly, it's easy)
https://github.com/BeyondCodeBootcamp/beyondcodebootcamp/issues/2#markdown
What should a README be?
Projects should have READMEs that have
Great READMEs
Master Markdown
(honestly, it's easy)