From 31d323f9e2527926ef50b476832cc096fd7ed0c7 Mon Sep 17 00:00:00 2001
From: Liang Chenye <liangchenye@huawei.com>
Date: Thu, 2 Jul 2020 21:28:44 +0800
Subject: [PATCH] remove the duplicated pyyaml.yaml file; add docs about the
 metadata

Signed-off-by: Liang Chenye <liangchenye@huawei.com>
---
 README.en.md              | 58 ++++++++++++++++++++++++---------------
 upstream-info/pyyaml.yaml |  4 ---
 2 files changed, 36 insertions(+), 26 deletions(-)
 delete mode 100644 upstream-info/pyyaml.yaml

diff --git a/README.en.md b/README.en.md
index fdbd3106..b253cc37 100644
--- a/README.en.md
+++ b/README.en.md
@@ -1,11 +1,11 @@
 # openEuler-Advisor
 
-#### Description
+## Description
 Collection of automation tools for easily maintaining openEuler
 
 | Pharse           | Rules           | Requires  | Automatic  | Data & Tool   |
 |------------------|-----------------------|---|---|------|
-| 1.Select & Fetch | 1.1 Official Release  | official git/svn.. url  | from spec, from other package system  | [Data Standard](./template.yaml), [Data Source](./upstream-info)  |  
+| 1.Select & Fetch | 1.1 Official Release  | official git/svn.. url  | from spec, from other package system  | [Software Metadata](#Software-Metadata) |
 |                  | 1.2 Best Version     | release note、test、user feedback   | newest/stable/official/compatible version  |      |
 |                  | 1.3 Best Version Notify | issue/PR | auto issue/PR | |
 | 2.Package        | 2.1 Meta data | summary, deps ...  |  from spec, from other package system    |    |
@@ -16,34 +16,48 @@ Collection of automation tools for easily maintaining openEuler
 | 4.Test           | 4.1 Upstream Test & Feedback   | upstream test entry & feedback channel  | standard test entry & auto feedback  |  |
 | 5.Release        | TODO       |   |   |   
 
-#### Software Architecture
-Software architecture description
 
-#### Installation
+## Software Metadata
+### Configs
+```
+version_control: git
+src_repo: xxxx
+tag_prefix: ^v
+seperator: .
+```
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+**version_control**
+The type of a software's version control system.
+Now we support:  `svn/github/git/hg/metacpan/gitlab.gnome/pypi`
 
-#### Instructions
+**src_repo**
+The original official source url of a software.
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+**tag_prefix**
+The version name is not always the same with the tag name. 
+For example, if a software version is 1.0.0, the tag might be v1.0.0. `v` here is the prefix.
 
-#### Contribution
+**seperator**
+The seperator of a software's version name. For example, if a software version is 1.0.0, the seperator is `.`.
+
+### How to add a software metadata file
+0. Please check if the metafile is already exist
+1. Copy the [Template](./template.yaml) to [Database Dir](./upstream-info)
+2. Rename the file name, it is suggested that the file name SHOULD be same with the repo name in `src-openeuler`.
+3. Find the official source url of the software.
+4. Check the version control type, the tag prefix and the seperator
+5. Fill the configs
+
+DONE! than you can create a Pull Request.
+
+### Metadata Database
+[Database](./upstream-info)  
+
+
+## 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/upstream-info/pyyaml.yaml b/upstream-info/pyyaml.yaml
deleted file mode 100644
index ad08f1e2..00000000
--- a/upstream-info/pyyaml.yaml
+++ /dev/null
@@ -1,4 +0,0 @@
----
-version_control: github
-src_repo: yaml/pyyaml
-seperator: .
-- 
GitLab