From a8f5a507b1f60fe3b10e949eb94e96ecfe12bafd Mon Sep 17 00:00:00 2001
From: Makiras <22570332+Makiras@users.noreply.github.com>
Date: Tue, 30 Apr 2024 04:11:35 +0000
Subject: [PATCH] [WIP] add task

---
 Readme_cn.md   | 15 +--------------
 doc/env_cn.md  | 49 ++++++++++++++++++++++++-------------------------
 doc/join_cn.md |  2 ++
 3 files changed, 27 insertions(+), 39 deletions(-)

diff --git a/Readme_cn.md b/Readme_cn.md
index a2c42ed..537d6a3 100644
--- a/Readme_cn.md
+++ b/Readme_cn.md
@@ -59,17 +59,4 @@ QQ群
 ```python
 import base64
 base64.b64decode('Your_Base64_Data_Here').decode()
-```
-
-微信群
-```python
-import base64
-from io import BytesIO
-from PIL import Image
-base64_image_data = \
-"Your_Base64_Image_Data_Here_0"\
-"Your_Base64_Image_Data_Here_1"
-image_data = base64.b64decode(base64_image_data)
-image = Image.open(BytesIO(image_data))
-image.show()
-```
+```
\ No newline at end of file
diff --git a/doc/env_cn.md b/doc/env_cn.md
index c0d366c..e087e3c 100644
--- a/doc/env_cn.md
+++ b/doc/env_cn.md
@@ -1,19 +1,28 @@
 # BPU验证环境
 
-本环境提供BPU验证所需的所有依赖，以及工具包。本验证环境需要在linux系统下运行，它包含了如何生成带验证的Python DUT模块、验证示例、验证报告生成等模块。（待验证模块对应的香山仓库为：[github.com/OpenXiangShan/XiangShan](https://github.com/OpenXiangShan/XiangShan/tree/kunminghu)，commit为：[ea2f767c24941b08d375b2b9529cd11b5850960a](https://github.com/OpenXiangShan/XiangShan/tree/ea2f767c24941b08d375b2b9529cd11b5850960a)）
+本环境提供BPU验证所需的所有依赖，以及工具包。本验证环境需要在linux系统下运行，包含以下组件
+
+1. 生成待验证的 Python DUT 模块
+2. 对DUT进行验证的示例项目
+3. 生成验证报告的组件
+
+待验证项目：
+
+- 待验证模块：[XiangShan ea2f767](https://github.com/OpenXiangShan/XiangShan/tree/ea2f767c24941b08d375b2b9529cd11b5850960a)
 
 
 ## 安装依赖
 
-除去基本的gcc/python3开发环境外，本验仓库还依赖RTL仿真器 Verilator（4.218 ）、Picker工具、MLVP库。具体安装方法请参考以下链接。
+除去基本的gcc/python3开发环境外，本验仓库还依赖如下两个项目，请先行安装，**并安装对应项目的依赖**。
 
-1. [Verilator](https://www.veripool.org/projects/verilator/wiki/Installing)
-2. [Picker](https://github.com/XS-MLVP/picker)
-3. [mlvp](https://github.com/XS-MLVP/mlvp)
+1. [Picker](https://github.com/XS-MLVP/picker)
+2. [MLVP](https://github.com/XS-MLVP/mlvp)
 
-通过以下命令安装python依赖：
+再通过以下命令安装其他依赖：
 ```bash
-pip3 install XXXX XXXX XXXX
+apt install lcov # genhtml
+pip install pytest-sugar pytest-rerunfailures pytest-xdist pytest-assume pytest-html # pytest
+
 ```
 
 ## 生成待验证模块
@@ -76,18 +85,6 @@ if __name__ == "__main__":
 
 其他待验证模块，例如 TAGE-SC，FTB也可以通过类似命令生成。
 
-### Tage SC
-
-```bash
-make tage_sc TL=python
-```
-
-### FTB
-
-```bash
-make ftb TL=python
-```
-
 **支持的模块名称有：uftb、tage_sc、ftb、ras、ittage。也可以通过如下命令，一次性生成所有DUT模块。**
 
 ```bash
@@ -118,24 +115,26 @@ BRTParser 使我们专门为 BPU 验证所设计的能够自动抓取、解析
 
 ### 编写TestCase
 
-TBD
+
 
 #### 创建测试函数
 
-本验证环境基于Pytest进行搭建，因此如何编写test请参考文档：XXXXX。在本示例中，编写了如下test：
+本验证环境基于Pytest进行搭建，因此如何编写test请参考[对应文档](https://open-verify.cc/mlvp/docs/quick-start/frameworks/pytest/)。
+
+在本示例中，编写了如下test：
 
 ```bash
-xxxx/test_xxx.py
+
 ```
 
 #### 发送激励
 
-TDB
+
 
 #### 运行测试
 
-TBD
+
 
 #### 生成测试报告
 
-TBD
+
diff --git a/doc/join_cn.md b/doc/join_cn.md
index 73f6ebc..96a949c 100644
--- a/doc/join_cn.md
+++ b/doc/join_cn.md
@@ -71,3 +71,5 @@ Fork本仓库，然后在本地进行环境搭建，参与测试任务。
 1. 修复本项目中文档，代码中出现的错误，按错误等级获取积分
 1. 提交最终验证报告，按报告质量，覆盖率获得积分
 1. 最终汇报得分
+
+## 任务
\ No newline at end of file