GitHub - RichardLitt/standard-readme: A standard style for README files

standard-readme是一个堪称教科书式的Readme项目，它为开发者提供一份标准化的编写规范。很多开发者在Github上创建一个项目的时候，往往忽视了Readme的重要性，实际上，Readme文件通常是你开源项目的第一个入口点，它的作用主要有告诉人们为什么应该使用你的项目，以及如何安装和使用，一份标准化的Readme可以简化它的创建和维护，所以Readme值得你花时间去创建。

一份最基本的Readme必须由以下部分组成。

• Title：标题
• Short Description：简短描述
• Table of Contents：内容列表
• Install：安装
• Usage：用法
• License：许可证书

minimal-readme

Title

This is an example file with default selections.

Install

Usage

Contributing

PRs accepted.

License

MIT © Richard McRichface

maximal-readme

Title

This is an example file with maximal choices selected.

This is a long description.

Table of Contents

• Security
• Background
• Install
• Usage
• API
• Contributing
• License

Security

Any optional sections

Background

Any optional sections

Install

This module depends upon a knowledge of Markdown.

Any optional sections

Usage

Note: The license badge image link at the top of this file should be updated with the correct :user and :repo.

Any optional sections

API

Any optional sections

More optional sections

Contributing

See the contributing file!

PRs accepted.

Small note: If editing the Readme, please conform to the standard-readme specification.

Any optional sections

License

MIT © Richard McRichface.

徽章图标

Shields.io | Shields.io

徽章图标都是由Shields动态生成。Shields是一个以SVG或光栅格式提供简洁清晰的徽章服务，可轻松地应用在Readme或任何网页中。

该服务支持数十种持续集成服务、软件包注册表、发行版、应用商店、社交网络、代码覆盖率服务和代码分析服务，每个月提供超过7.7亿张图像。基本上每个受欢迎的开源项目都会使用Shields提供的徽章服务。