From 39a70f92dfba026bd3b35e0b4019cca7e5a2f03c Mon Sep 17 00:00:00 2001
From: nocjj <1250062498@qq.com>
Date: Mon, 7 Sep 2020 09:08:24 +0800
Subject: [PATCH] README: add README for project

Add English README for project.

Signed-off-by: Jiajun Chen <1250062498@qq.com>
---
 README.en.md | 36 --------------------
 README.md    | 93 ++++++++++++++++++++++++++++++++--------------------
 2 files changed, 58 insertions(+), 71 deletions(-)
 delete mode 100644 README.en.md

diff --git a/README.en.md b/README.en.md
deleted file mode 100644
index 5a00f17..0000000
--- a/README.en.md
+++ /dev/null
@@ -1,36 +0,0 @@
-# vmtop
-
-#### Description
-A tool for collecting and analyzing data of virtual machine
-
-#### Software Architecture
-Software architecture description
-
-#### Installation
-
-1.  xxxx
-2.  xxxx
-3.  xxxx
-
-#### Instructions
-
-1.  xxxx
-2.  xxxx
-3.  xxxx
-
-#### Contribution
-
-1.  Fork the repository
-2.  Create Feat_xxx branch
-3.  Commit your code
-4.  Create Pull Request
-
-
-#### Gitee Feature
-
-1.  You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
-2.  Gitee blog [blog.gitee.com](https://blog.gitee.com)
-3.  Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
-4.  The most valuable open source project [GVP](https://gitee.com/gvp)
-5.  The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
-6.  The most popular members  [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
diff --git a/README.md b/README.md
index 2708db6..f6e9139 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,60 @@
 # vmtop
 
-#### 介绍
-A tool for collecting and analyzing data of virtual machine
-
-#### 软件架构
-软件架构说明
-
-
-#### 安装教程
-
-1.  xxxx
-2.  xxxx
-3.  xxxx
-
-#### 使用说明
-
-1.  xxxx
-2.  xxxx
-3.  xxxx
-
-#### 参与贡献
-
-1.  Fork 本仓库
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
-
-
-#### 码云特技
-
-1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
-2.  码云官方博客 [blog.gitee.com](https://blog.gitee.com)
-3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
-4.  [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
-5.  码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
-6.  码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+A tool for collecting and analyzing data of virtual machine.
+
+### Description
+vmtop is a user-mode tool running on the host, which can dynamically view the resource usage of virtual machines in real time, include CPU usage, memory usage, vcpu kvm exits. It brings great convenience to virtualization problems and performance optimization, and is a pratical tool that intergrates multi-party info to monitor virtual machines.
+
+### Building
+This project uses ncurses, ncurses-devel, autoconf, libvirt, libvirt-devel. Go to check them out if you do not have them locally installed.
+
+The simple steps to make vmtop are:
+```sh
+1.  aclocal
+2.  autoconf
+3.  autoheader
+4.  automake --add-missing
+5.  ./configure
+6.  make
+```
+And then you will find vmtop in the source code dictionary.
+
+### Introductions
+#### usage
+Run directly from the commandline.
+```sh
+vmtop [-option]
+```
+#### start option
+- d: Set delay time between two display
+- H: Show threads
+- n: Set display times, default no limit
+
+#### shortcut key
+- H: Open thread mode or close thread mode
+- q: Quit from vmtop
+- f: Show fields filter
+
+
+### Contribution
+
+#### Git
+1.  Fork the repository
+2.  Create Feat_xxx branch
+3.  Commit your code
+4.  Create Pull Request
+
+#### Style
+It is much better to be consistent with the exiting files. For new files:
+- C: use kernel code style
+- others: keep same with exiting files
+
+#### Patches
+Use 'git format-patch' to format patched and use 'git send-email' to send mail to [@openeuler](virt@openeuler.org) mailing list. And if it is a patch set, it is much better to use '--cover-letter' option when you format patches, so that we can understand what the pacthset does.
+
+### Maintainers
+[@zhanghailiang](https://gitee.com/zhanghailiang_luckyh)
+[@nocjj](https://gitee.com/nocjj)
+
+### License
+[Mulan](License/LICENSE)
-- 
GitLab