add comment

README.md

-# cvevulner
+# cve-manager
 
-#### 介绍
-{**以下是码云平台说明，您可以替换此简介**
-码云是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台
-无论是个人、团队、或是企业，都能够用码云实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)}
+## Introduction
 
-#### 软件架构
-软件架构说明
-##### issue 分析评论规则
-issue分析员注意事项
-1. 分析以/analysis标识开始
-2. 分析完结以 /end 结束
-3. 分析issue后需要在评论中修改issue中的模板字段值必须用对应评论标签包裹
+This repository is used to address the code of openEuler cve manager.
 
-    | 模板字段中文名   | 模板字段英文名  |    评论标签    |
-    | -------------  | ------------- | ------------- |
-    |    漏洞编号     | Loophole number|  [LN][/LN]    |
-    |    漏洞组件     | loophole ascription component | [LAC][/LAC] |
-    |    漏洞版本     | loophole ascription version | [LAV][/LAV] |
-    |    CVSS v3.0分值     | cvss v3.0 score | [CVS][/CVS] |
-    |    CVSS 向量     | cvss V3.1 vector | [CVV][/CVV] |
-    |    漏洞 描述     | loophole description | [LD][/LD] |
-    |    影响分析说明     | impact analysis description | [IAD][/IAD] |
-    |    原理分析     | principle  analysis | [PA][/PA] |
-    |    openEuler评分     | openEuler  score | [OES][/OES] |
-    |    openEuler向量     | openEuler Vector  | [OEV][/OEV] |
-    |    影响的版本     | impact version | [IV][/IV] |
-    |    规避方案和措施     | Circumvention plan or mitigation measures | [CPMM][/CPMM] |
-    |    影响的包    | impact wrap| [IW][/IW]
-- 分析issue填写模板（ps 每一次分析评论必须用/analysis指令 填写项可以一次填完也可不填写完 填写完成加上/done指令 
- /analysis
- 影响分析说明:[IAD]此处为填写影响分析说明的内容[/IAD]
- 原理分析:[PA]此处为填写原理分析的内容[/PA]
- openEuler评分:[OES]此处为填写openEuler评分的内容[/OES]
- openEuler向量:[OEV]此处为填写openEuler向量的内容[/OEV]
- 影响的版本:[IV]此处为填写影响版本的内容[/IV]
- 规避方案和措施:[IV]此处为填写规避方案和措施的内容[/IV]
- 影响的包:[IW]此处为填写影响的包的内容(内容以英文逗号分隔)[/IW]
- /done
+## Architecture
 
+<img src="./doc/image/Framework.png" />
 
+## Prerequisites
 
-#### 安装教程
+You'll need to setup a MySQL Database before you are getting started.
+This is an example to create Database instance.
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+* Setup MySQL instance by the Huawei Cloud Relational Database Service (RDS)
+* Login in MySQL with your account and password
+* Create database instance by running the following command
+    ```
+    CREATE DATABASE cvevulner;
+    source ./doc/sql/db_struct.sql;
+    ```
+The information of database instance will be used in the following Installation.
 
-#### 使用说明
+## Getting Started
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+* [Build the project](doc/md/installx.md)
 
-#### 参与贡献
+## Process processing help
 
-1.  Fork 本仓库
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
+See the [Process processing help](doc/md/installx.md) file for details.
+> For Chinese version, please refer to [命令帮助](doc/md/installx.md).
 
-
-#### 码云特技
-
-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/)

doc/md/installx.md

+# Getting Started on md
+
+## Build
+
+
+* Before you get started, make sure to have [Go](https://golang.org/) already installed in your local machine.
+
+* Install beego
+    ```cassandraql
+    go get -u github.com/astaxie/beego
+  go get -u github.com/beego/bee
+    ```
+  [Reference documents](https://beego.me/)
+  
+ * The configuration environment variable values are as follows:
+     ```cassandraql
+    DB_PWD,DB_USER,AES_KEY,GITEE_CLIENT_ID,GITEE_CLIENT_SECRET,GITEE_PASSWORD,HOOK_PWD,GITEE_TOKEN
+    ```
+## Usage
+
+* run
+    ```
+    bee run
+    ```
\ No newline at end of file

doc/md/manual.md

+##### issue 分析评论规则 
+issue分析员注意事项
+1. 分析以/analysis标识开始
+2. 分析完结以 /end 结束
+3. 分析issue后需要在评论中修改issue中的模板字段值必须用对应评论标签包裹
+
+    | 模板字段中文名   | 模板字段英文名  |    评论标签    |
+    | -------------  | ------------- | ------------- |
+    |    漏洞编号     | Loophole number|  [LN][/LN]    |
+    |    漏洞组件     | loophole ascription component | [LAC][/LAC] |
+    |    漏洞版本     | loophole ascription version | [LAV][/LAV] |
+    |    CVSS v3.0分值     | cvss v3.0 score | [CVS][/CVS] |
+    |    CVSS 向量     | cvss V3.1 vector | [CVV][/CVV] |
+    |    漏洞 描述     | loophole description | [LD][/LD] |
+    |    影响分析说明     | impact analysis description | [IAD][/IAD] |
+    |    原理分析     | principle  analysis | [PA][/PA] |
+    |    openEuler评分     | openEuler  score | [OES][/OES] |
+    |    openEuler向量     | openEuler Vector  | [OEV][/OEV] |
+    |    影响的版本     | impact version | [IV][/IV] |
+    |    规避方案和措施     | Circumvention plan or mitigation measures | [CPMM][/CPMM] |
+    |    影响的包    | impact wrap| [IW][/IW]
+- 分析issue填写模板（ps 每一次分析评论必须用/analysis指令 填写项可以一次填完也可不填写完 填写完成加上/done指令 
+ /analysis
+ 影响分析说明:[IAD]此处为填写影响分析说明的内容[/IAD]
+ 原理分析:[PA]此处为填写原理分析的内容[/PA]
+ openEuler评分:[OES]此处为填写openEuler评分的内容[/OES]
+ openEuler向量:[OEV]此处为填写openEuler向量的内容[/OEV]
+ 影响的版本:[IV]此处为填写影响版本的内容[/IV]
+ 规避方案和措施:[IV]此处为填写规避方案和措施的内容[/IV]
+ 影响的包:[IW]此处为填写影响的包的内容(内容以英文逗号分隔)[/IW]
+ /done
+ 
+ #### security-committee ####
+  * 整理中
\ No newline at end of file