From d6a5e74dcce347df1a072c863bb4a391bfab70db Mon Sep 17 00:00:00 2001
From: Liupeng <abici@163.com>
Date: Mon, 6 Sep 2021 08:31:04 +0000
Subject: [PATCH] New file Added a file about how to write a README

---
 .../how-to-write-a-README.MD                  | 120 ++++++++++++++++++
 1 file changed, 120 insertions(+)
 create mode 100644 translation-projects/README-optimization/how-to-write-a-README.MD

diff --git a/translation-projects/README-optimization/how-to-write-a-README.MD b/translation-projects/README-optimization/how-to-write-a-README.MD
new file mode 100644
index 0000000..0497920
--- /dev/null
+++ b/translation-projects/README-optimization/how-to-write-a-README.MD
@@ -0,0 +1,120 @@
+# 如何写作README
+
+<img src="https://readme.com/static/team.png" alt="readme" title="readme" style="zoom:50%;" />
+
+
+
+通常，开发者和用户要了解你的项目，会首先去看项目的README文件。   
+
+**README文件应该明确地告诉大家，你的项目是用来做什么的，为什么他们应该使用你的项目，以及如何安装它、使用它。 **   
+
+可点击文末的[README样例链接](#README内容其他说明)，进一步理解本文所述的内容。  
+
+## 你将了解：
+
+* [README内容构成要素](#README内容构成要素)
+* [项目徽章](#项目徽章)
+* [项目介绍 ](#项目介绍)
+* [目录](#目录)
+* [如何使用](#如何使用)
+* [参与贡献](#参与贡献)
+* [许可证](#许可证)
+* [辅助信息](#辅助信息)
+* [README内容其他说明](#README内容其他说明)
+
+## :blue_heart:README内容构成要素  
+
+一般来讲，一个开源项目的README文件，可能包含以下几个内容：  
+
+:one: 项目徽章  
+
+:two: **项目介绍（必选） ** 
+
+:three: 目录  
+
+:four: **如何使用（必选） ** 
+
+:five: 参与贡献  
+
+:six: **许可证（必选） ** 
+
+:seven: 辅助信息  
+
+来吧，让我们一起看看如何写出一个出色的README文件。    
+
+
+
+***
+
+## :dart:项目徽章
+
+项目徽章（badges），一般处于项目名称的正下方。  
+
+我们可以添加徽章对项目进行标记和说明，这些好看的小图标不仅简洁美观，而且还包含了清晰易读的信息。  
+
+**常用的徽章主要有项目版本、下载量、支持平台、开发语言、许可证类型、集成状态等。**     
+
+例如：    
+
+<img src="https://res.cloudinary.com/practicaldev/image/fetch/s--9L2HCK0J--/c_imagga_scale,f_auto,fl_progressive,h_420,q_auto,w_1000/https://dev-to-uploads.s3.amazonaws.com/i/uyujugdij57cmwovyi85.png" alt="badges" title="badges" style="zoom: 50%;" />
+
+## :dart:目录
+
+如果你的文档很长，可以添加一个目录（Contents），为读者做一个快速导航，方便读者快速找到自己想看的内容。   
+
+例如当前README中的目录。  
+
+## :dart:项目介绍
+
+必选内容。在这里写上对项目的介绍。简介项目是什么、它的用途、关键特性/优势等。此部分内容，一般不需要标题。  
+
+例如：   
+
+iSulad is a lightweight container runtime daemon, which is designed for IoT and Cloud infrastructure. iSulad is light and fast, and is not limited by hardware architecture or specifications.   
+
+## :dart:如何使用
+
+必选内容。简介如何来安装和使用项目中的开源软件。基础内容为“安装（Installation）”，还可以包含“快速入门（Quick Start）”。如果觉得有必要提供完整的使用指导信息，可以添加项目官方文档中心的链接。
+
+* 安装（Installation）  
+
+  介绍如何在本地安装你的项目。通常只需要列出关键的操作步骤即可。    
+
+* 快速入门（Quick Start）  
+
+  介绍如何快手上手操作。 依据典型场景，给出普适性的项目使用步骤。  
+
+## :dart:参与贡献
+
+这部分内容可以包含：  
+
+* 通过什么样的途径参与贡献（How to Contribute）  
+
+* 有什么样的注意事项  
+
+* 贡献者名单（Contributors）  
+
+## :dart:许可证
+
+必选内容。许可证（License，也称“协议”）决定了使用者是否采用某个开源项目，规避知识产权风险。    
+
+这里只需要写上采用的许可证名称即可，可以不进行具体描述。  
+
+常见许可证：GPL、BSD、MIT、Mozilla、Apache、LGPL。  
+
+## :dart:辅助信息
+
+为方便大家更好地了解你的项目，可提供项目的扩展信息，包括不限于：    
+
+安全问题（Security Issues）、开发计划、免责声明（Disclaimer）、致谢、相关资源链接等。  
+
+
+
+*********
+
+## :blue_heart:README内容其他说明
+
+* README里只提供核心的精简信息，便于参与者快速了解你的项目。如果需要提供项目的具体细节，可在相关内容的位置，添加必要的扩展阅读链接。
+
+* 可在README里添加必要的图、表，提高项目参与者的阅读兴趣。
+* 点击阅读README样例，进一步理解本文所述的内容：[iSulad](https://gitee.com/openeuler/iSulad)、[MindSpore](https://github.com/mindspore-ai/mindspore)、[react](https://github.com/facebook/react)
\ No newline at end of file
-- 
Gitee