# ChineseREADME

**Repository Path**: sunyctf/chinesereadme

## Basic Information

- **Project Name**: ChineseREADME
- **Description**: 🌐中文标准README在线文档🌐
https://sunyctf.github.io/ChineseREADME/
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://gitee.com/sunyctf/chinesereadme
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-04-08
- **Last Updated**: 2023-01-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Markdown, HTML, CSS

## README

# 标准中文README

[![](https://img.shields.io/badge/%E4%B8%BB%E9%A1%B5-sunyctf%2FChineseREADME-orange)](https://gitee.com/sunyctf/ChineseREADME)

README 文件通常是代码的第一个入口点。它应该告诉别人如何安装它，以及如何使用它。标准化编写 README 的方式可简化创建和维护你的 README 。

## 目录

- [背景](#背景)
- [安装](#安装)
- [用法](#用法)
- [相关项目（可选）](#相关项目)
- [主要项目负责人](#主要项目负责人)
- [参与贡献方式](#参与贡献方式)
    - [贡献人员](#贡献人员)
- [开源协议](#开源协议)

## 背景

因为现在 Github 上的中国程序员越来越多，但是 Github 还是以英文为主导，对某些英语能力较弱的中国人不友好。所以，我根据 [@RichardLitt](https://github.com/RichardLitt) 主导的标准 README 项目 [RichardLitt/standard-readme](https://github.com/RichardLitt/standard-readme) 编写了中文版的标准 README 。

## 安装

[![](https://img.shields.io/badge/%E4%B8%8B%E8%BD%BD-README.md-orange)](README.md)

Github 上的 README 一般是用 Markdown 编写的，所以后缀名是 .md 。所以你需要一个 Markdown 编辑器，我个人推荐使用 [Visual Studio Code](https://code.visualstudio.com/) 。

## 用法

你可以直接下载 [README.md](README.md) 文件或者用 git 克隆此工程。然后使用 [Visual Studio Code](https://code.visualstudio.com/) 等 Markdown 编辑器打开 [README.md](README.md) 文件，然后根据 [README.md](README.md) 的标准格式套用到你自己项目的 README 中。

使用 Markdown 语法编辑 README 。
- [目录](#目录)下的项是一个项目的 README 一般需要包含的内容。
- 在[背景](#背景)项下，说明该项目的开发背景，简要概述一下整个项目。
- 在[安装](#安装)项下，说明整个项目的安装方法，尽量详细一点，如果篇幅过大可以另用其他文档描述。
- 在[用法](#用法)项下，说明该项目的使用方法，尽量详细，如果篇幅过大也可以另用其他文档进行描述。
- 在[相关项目](#相关项目)项下写明与该项目相关的其他项目，如果没有，可以不写。
- 在[主要项目负责人](#主要项目负责人)项下，写明该项目由谁负责。
- 在[参与贡献方式](#参与贡献方式)项下，说明如何参与贡献该项目。在[贡献人员](#贡献人员)项下，写明全部或者主要的贡献人员，以向他们表示感谢。
- 在[开源协议](#开源协议)项下，写明该项目的开源协议。

除上述的之外，还可以根据自己的具体项目进行调整增添删减。也可以适当在 README 中加入徽章，例如本文件的开头的：

[![](https://img.shields.io/badge/%E4%B8%BB%E9%A1%B5-sunyctf%2FChineseREADME-orange)](https://gitee.com/sunyctf/ChineseREADME)

你可以在 [shields](https://shields.io) 中自己创作。

## 相关项目

暂无

## 主要项目负责人

[@Andy](https://gitee.com/sunyctf)

## 参与贡献方式

[![](https://img.shields.io/badge/%E7%94%B3%E8%AF%B7-Pull%20Request-orange)](https://gitee.com/sunyctf/ChineseREADME/pulls)

提交 [PR](https://gitee.com/sunyctf/ChineseREADME/pulls) 申请，我会视情况通过。

### 贡献人员

感谢所有贡献的人。

[@Andy](https://github.com/sunyctf)

## 开源协议

[MIT](LICENSE) © Andy