1
0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-02 09:33:06 +02:00

Translate some readme templates in Chinese (#42)

* Translate Minimal.md in Chinese

* Translate README.md in Chinese

* Translate Standard.md in Chinese

* fix translate work deployment error in Chinese
This commit is contained in:
doseeing
2022-10-06 03:43:27 +08:00
committed by GitHub
parent 677793274e
commit 2e3730f30b
3 changed files with 147 additions and 1 deletions

View File

@@ -0,0 +1,44 @@
# 项目名称
## 目录
+ [关于](#about)
+ [快速开始](#getting_started)
+ [使用方法](#usage)
+ [贡献](../CONTRIBUTING.md)
## 关于 <a name = "about"></a>
关于你项目的目的写1-2个段落。
## 快速开始 <a name = "getting_started"></a>
这些指令会让你复制整个项目,并在本地机器上运行以进行开发和测试。
查看[部署](#deployment),获取如何在线上系统部署的信息。
### 准备工作
需要哪些软件以及如何安装它们。
```
例子
```
### 安装
一步步的介绍如何运行开发环境。
介绍每个步骤
```
给出例子
```
然后重复
```
直到完成
```
在例子最后从搭好的系统中获取一些数据或者介绍如何使用它做个小的demo展示。
## 使用方法 <a name = "usage"></a>
介绍如何使用这个系统。

View File

@@ -1,4 +1,4 @@
### This folder contains various README Templates that one can use based on the type of project.
### 这个文件夹包括了一些README的模板可根据你的项目类型选择。
1. [Bot.md](/README%20Templates/Bot.md) -
2. [Hackathon.md](/README%20Templates/Hackathon.md) -

View File

@@ -0,0 +1,102 @@
<p align="center">
<a href="" rel="noopener">
<img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
</p>
<h3 align="center">项目名称</h3>
<div align="center">
[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
</div>
---
<p align="center"> 简短几行来描述你的项目
<br>
</p>
## 📝 目录
- [关于](#about)
- [快速开始](#getting_started)
- [部署](#deployment)
- [使用方法](#usage)
- [构建使用库](#built_using)
- [待完成](../TODO.md)
- [贡献](../CONTRIBUTING.md)
- [作者](#authors)
- [致谢](#acknowledgement)
## 🧐 关于 <a name = "about"></a>
关于你项目的目的写1-2个段落。
## 🏁 快速开始 <a name = "getting_started"></a>
这些指令会让你复制整个项目,并在本地机器上运行以进行开发和测试。
查看[部署](#deployment),获取如何在线上系统部署的信息。
### 准备工作
需要哪些软件以及如何安装它们。
```
例子
```
### 安装
一步步的介绍如何运行开发环境。
介绍每个步骤
```
给出例子
```
然后重复
```
直到完成
```
在例子最后从搭好的系统中获取一些数据或者介绍如何使用它做个小的demo展示。
## 🔧 运行测试 <a name = "tests"></a>
解释如何对系统运行自动化测试。
### 分解到端对端测试
解释测试的内容以及为什么
```
给出例子
```
### 还有代码风格测试
解释测试的内容以及为什么
```
给出例子
```
## 🎈 使用方法 <a name="usage"></a>
介绍如何使用这个系统。
## 🚀 部署 <a name = "deployment"></a>
增加一些关于如何部署到线上系统的信息。
## ⛏️ 构建使用库 <a name = "built_using"></a>
- [MongoDB](https://www.mongodb.com/) - 数据库
- [Express](https://expressjs.com/) - 服务器框架
- [VueJs](https://vuejs.org/) - Web框架
- [NodeJs](https://nodejs.org/en/) - 服务器环境
## ✍️ 作者 <a name = "authors"></a>
- [@kylelobo](https://github.com/kylelobo) - 想法和最初工作
同样感谢这些[贡献者](https://github.com/kylelobo/The-Documentation-Compendium/contributors)参与到本项目的工作中。
## 🎉 致谢 <a name = "acknowledgement"></a>
- 感谢所有为这个项目
- 提供灵感的代码编写者
- 提供参考的代码编写者