The README file is one you normally see when you’ve downloaded source code in order to compile and install it on your system. It (hopefully) is a guide that helps you understand, install, and set up your new application with ease. Writing the ever-popular README file isn’t as straightforward as you might think. This guide makes it easy.

Source: LXer – Sysadmin university: How to write a README file