From 17b5bf32463aa63eaafed08b7f51a0965cacb9c8 Mon Sep 17 00:00:00 2001
From: jonah2357 <18001212351@163.com>
Date: Mon, 12 Jun 2023 20:48:15 +0800
Subject: [PATCH] add README.md

---
 README.md | 52 +++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 39 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 83a79c99..f5669da7 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,27 @@
 # utshell
 
 #### 介绍
-The GNU Bourne Again shell (Bash) is a shell or command language interpreter that is compatible with the Bourne shell (sh). Bash incorporates useful features from the Korn shell (ksh) and the C shell (csh). Most sh scripts can be run by utshell without modification.
+utshell is use rust rewrote bash. and enhanced security.
+now it is base on bash. and we will gradually remove dependence on bash.
 
 #### 软件架构
 软件架构说明
 
 
-#### 安装教程
+### Dependencies
+glibc, bash
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
 
-#### 使用说明
+### Build from source code
+./configure
+make
 
+
+## Installation
+make install 
+
+
+#### 使用说明
 1.  xxxx
 2.  xxxx
 3.  xxxx
@@ -27,11 +34,30 @@ The GNU Bourne Again shell (Bash) is a shell or command language interpreter tha
 4.  新建 Pull Request
 
 
-#### 特技
+## Documentations
+If any, link the documentation here. Please ensure the linked pages can be accessible from the public internet.
+
+- Link 1
+- Link 2
+- ...
+
+## Getting help
+
+- [Official Forum](https://bbs.deepin.org/) for generic discussion and help.
+- [Developer Center](https://github.com/linuxdeepin/developer-center) for BUG report and suggestions.
+- [Wiki](https://wiki.deepin.org/)
+（按照项目实际情况放帮助链接）
+
+## Getting involved
+
+We encourage you to report issues and contribute changes
+
+- [Contribution guide for developers](https://github.com/linuxdeepin/developer-center/wiki/Contribution-Guidelines-for-Developers-en) (English)
+- [Translate for your language on Transifex](#) *please update to the actual Transifex link of this project*
+（按照项目实际情况放贡献指南链接）
+
+## License
+
+License description here. The license name is suggested to use the same one as [SPDX license identifier](https://spdx.org/licenses). Following is an example:
 
-1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
-2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
-3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
-4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
-5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
-6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+utshell is licensed under [GPL-3.0-or-later](LICENSE)
-- 
Gitee