From 2e3730f30b439b43d789722a7f1e02ff83c9927f Mon Sep 17 00:00:00 2001 From: doseeing Date: Thu, 6 Oct 2022 03:43:27 +0800 Subject: [PATCH] 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 --- cn/README_TEMPLATES/Minimal.md | 44 ++++++++++++++ cn/README_TEMPLATES/README.md | 2 +- cn/README_TEMPLATES/Standard.md | 102 ++++++++++++++++++++++++++++++++ 3 files changed, 147 insertions(+), 1 deletion(-) diff --git a/cn/README_TEMPLATES/Minimal.md b/cn/README_TEMPLATES/Minimal.md index e69de29..a29d3c9 100644 --- a/cn/README_TEMPLATES/Minimal.md +++ b/cn/README_TEMPLATES/Minimal.md @@ -0,0 +1,44 @@ +# 项目名称 + +## 目录 ++ [关于](#about) ++ [快速开始](#getting_started) ++ [使用方法](#usage) ++ [贡献](../CONTRIBUTING.md) + +## 关于 +关于你项目的目的,写1-2个段落。 + +## 快速开始 +这些指令会让你复制整个项目,并在本地机器上运行以进行开发和测试。 +查看[部署](#deployment),获取如何在线上系统部署的信息。 + +### 准备工作 + +需要哪些软件以及如何安装它们。 + +``` +例子 +``` + +### 安装 + +一步步的介绍如何运行开发环境。 + +介绍每个步骤 + +``` +给出例子 +``` + +然后重复 + +``` +直到完成 +``` + +在例子最后,从搭好的系统中获取一些数据,或者介绍如何使用它做个小的demo展示。 + +## 使用方法 + +介绍如何使用这个系统。 diff --git a/cn/README_TEMPLATES/README.md b/cn/README_TEMPLATES/README.md index 414d525..602d0aa 100644 --- a/cn/README_TEMPLATES/README.md +++ b/cn/README_TEMPLATES/README.md @@ -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) - diff --git a/cn/README_TEMPLATES/Standard.md b/cn/README_TEMPLATES/Standard.md index e69de29..d0237f5 100644 --- a/cn/README_TEMPLATES/Standard.md +++ b/cn/README_TEMPLATES/Standard.md @@ -0,0 +1,102 @@ +

+ + Project logo +

+ +

项目名称

+ +
+ + [![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) + +
+ +--- + +

简短几行来描述你的项目 +
+

+ +## 📝 目录 +- [关于](#about) +- [快速开始](#getting_started) +- [部署](#deployment) +- [使用方法](#usage) +- [构建使用库](#built_using) +- [待完成](../TODO.md) +- [贡献](../CONTRIBUTING.md) +- [作者](#authors) +- [致谢](#acknowledgement) + +## 🧐 关于 +关于你项目的目的,写1-2个段落。 + +## 🏁 快速开始 +这些指令会让你复制整个项目,并在本地机器上运行以进行开发和测试。 +查看[部署](#deployment),获取如何在线上系统部署的信息。 + +### 准备工作 + +需要哪些软件以及如何安装它们。 + +``` +例子 +``` + +### 安装 +一步步的介绍如何运行开发环境。 + +介绍每个步骤 + +``` +给出例子 +``` + +然后重复 + +``` +直到完成 +``` + +在例子最后,从搭好的系统中获取一些数据,或者介绍如何使用它做个小的demo展示。 + +## 🔧 运行测试 +解释如何对系统运行自动化测试。 + +### 分解到端对端测试 +解释测试的内容以及为什么 + +``` +给出例子 +``` + +### 还有代码风格测试 +解释测试的内容以及为什么 + +``` +给出例子 +``` + +## 🎈 使用方法 +介绍如何使用这个系统。 + +## 🚀 部署 +增加一些关于如何部署到线上系统的信息。 + +## ⛏️ 构建使用库 +- [MongoDB](https://www.mongodb.com/) - 数据库 +- [Express](https://expressjs.com/) - 服务器框架 +- [VueJs](https://vuejs.org/) - Web框架 +- [NodeJs](https://nodejs.org/en/) - 服务器环境 + +## ✍️ 作者 +- [@kylelobo](https://github.com/kylelobo) - 想法和最初工作 + +同样感谢这些[贡献者](https://github.com/kylelobo/The-Documentation-Compendium/contributors)参与到本项目的工作中。 +## 🎉 致谢 +- 感谢所有为这个项目 +- 提供灵感的代码编写者 +- 提供参考的代码编写者