How to write a beautiful README file

2018-09-25

How to write a beautiful ReadMe file

A README is a documentation that is usually distributed with a piece of software that contains a description or precaution for the software.
A README shall be simple and easy.

MarkDown is neceesary

Write the ReadMe file with markdown.

The Content

The name of the project and all the module.
Simple description of the use of the lib.
How to built and install.
Author
Licenses

Beautify your README

Make some beautiful icon
There is a website shields.io, where you can make some beautiful icons for custom made.
Just like flows:

[![Author](https://img.shields.io/badge/author-strawberrylin-blue.svg)](https://strawberrylin.github.io/)

jsonContent: meta: false pages: false posts: title: true date: true path: true text: true raw: false content: false slug: false updated: false comments: false link: false permalink: false excerpt: false categories: false tags: true