# Standard Readme

{% embed url="<https://github.com/RichardLitt/standard-readme>" %}

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

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

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

## **minimal-readme** <a href="#blob-path" id="blob-path"></a>

{% embed url="<https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/minimal-readme.md>" %}

> ## Title
>
> This is an example file with default selections.
>
> ### Install
>
> ```
> ```
>
> ### Usage
>
> ```
> ```
>
> ### Contributing
>
> PRs accepted.
>
> ### License
>
> MIT © Richard McRichface

## **maximal-readme** <a href="#blob-path" id="blob-path"></a>

{% embed url="<https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/maximal-readme.md>" %}

> ## Title&#x20;
>
> ## [![license](https://camo.githubusercontent.com/4738d430387c93da0d49ef0428a7c7ddae18e81eaff99a014996d4f6b30fd3ef/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f3a757365722f3a7265706f2e737667)](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/LICENSE) [![standard-readme compliant](https://camo.githubusercontent.com/f116695412df39ab3c98d8291befdb93af123f56aecc79fff4b20c410a5b54c7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f726561646d652532307374796c652d7374616e646172642d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](https://github.com/RichardLitt/standard-readme)
>
> This is an example file with maximal choices selected.
>
> This is a long description.
>
> ### Table of Contents
>
> * [Security](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/maximal-readme.md#security)
> * [Background](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/maximal-readme.md#background)
> * [Install](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/maximal-readme.md#install)
> * [Usage](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/maximal-readme.md#usage)
> * [API](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/maximal-readme.md#api)
> * [Contributing](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/maximal-readme.md#contributing)
> * [License](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/maximal-readme.md#license)
>
> ### Security
>
> #### Any optional sections
>
> ### Background
>
> #### Any optional sections
>
> ### Install
>
> This module depends upon a knowledge of [Markdown](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes).
>
> ```
> ```
>
> #### 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](https://github.com/RichardLitt/standard-readme/blob/master/example-readmes/CONTRIBUTING.md)!
>
> PRs accepted.
>
> Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
>
> #### Any optional sections
>
> ### License
>
> [MIT © Richard McRichface.](https://github.com/RichardLitt/standard-readme/blob/master/LICENSE)

## **徽章图标**

{% embed url="<https://shields.io/>" %}

[![standard-readme compliant](https://camo.githubusercontent.com/f116695412df39ab3c98d8291befdb93af123f56aecc79fff4b20c410a5b54c7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f726561646d652532307374796c652d7374616e646172642d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](https://github.com/RichardLitt/standard-readme)

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

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://chenqianhe.gitbook.io/rules/readme/common-rules/standard-readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.