How to write a great README How to write a great README / tutorial / free

Thoughtbot explains how you can write a well thought out, easy to read readme file for your next project.
2 favorites
submitted over 4 years ago, by SkinnyGeek1010
How to write a great README popular tutorial

1 Comment


20170512 junda

xiaojun, 10 months ago

Login or to comment.

Tutorials are any resources you learn from.

Examples: an intro to html5 screencast, a pdf about git, photoshop effects tutorials, meta-programming in ruby, lambda calculus, higher-order fixed-point combinators.

Tools are websites, apps or services used -on- your project (indirectly), to aid the process.

Examples: A color scheme generator, email marketing software, usability heat maps, css3 code generators, a downloadable png compressor.

Assets are downloadable files used -in- your projects, usually as code, textures, or images.

Examples: a jquery sticky menu, photoshop brushes, background textures, mvc frameworks, twitter bootstrap, 960 grid system.