From 08de162c57e77cfce18f821a0e70b29b6d551983 Mon Sep 17 00:00:00 2001
From: changtao <changtao@kylinos.cn>
Date: Thu, 12 Oct 2023 10:15:28 +0800
Subject: [PATCH] =?UTF-8?q?=E5=A2=9E=E5=8A=A0README=E8=8B=B1=E6=96=87?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md               | 25 +++++++++++++++++++++++++
 detect-plugin/README.md | 26 ++++++++++++++++++++++++--
 2 files changed, 49 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 3d1fcda6..d85c794f 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+[中文](#死锁检测插件)|[English](#deadlock-detect)
+
 # 死锁检测插件
 
 #### 介绍
@@ -27,3 +29,26 @@ deadlock-detect 是一款基于银河麒麟桌面操作系统V10 (SP1)的拓展
 
 3. 使用方式
    查看插件首页[细节内容](detect-plugin/README.md)
+
+# deadlock-detect
+
+#### Instroduction
+deadlock-detect is an extension plugin based on the Kylin Desktop Operating System V10 (SP1), used for deadlock detection in C/C++/Java programs, helping developers to identify abnormal multi-threaded deadlock states in Linux system
+
+#### Software architecture
+Supported architectures
+
+| Architectures |       OS     |
+| ------------- | -------------|
+| x86           | Kylin V10SP1 |
+| arm           | Kylin V10SP1 |
+| loongarch     | Kylin V10SP1 |
+| x86           | openkylin1.0 |
+
+#### Build process 
+
+1.Installing a specific version of Node.js: Version requirement: >=16.14.x and <17 Download link: https://nodejs.org/dist/
+
+2.Compilation and installation: Dependencies: npm, yarn, vsce, vue Compilation: Run ./build.sh in the current directory to automatically compile and package the plugin. The compiled plugin can be found in the detect-plugin directory. Installation: Run code-oss --install-extension detect-plugin/*.vsix in the current directory to install the plugin.
+
+3.How to use: Check the plugin homepage for [detailed instructions](detect-plugin/README.md).
diff --git a/detect-plugin/README.md b/detect-plugin/README.md
index d32b4f2c..9f21665f 100644
--- a/detect-plugin/README.md
+++ b/detect-plugin/README.md
@@ -1,10 +1,11 @@
-# C/C++/java 程序死锁分析
+[中文](#C/C++/Java进程死锁分析)|[English](#C/C++/Java Process deadlock analysis)
+
+# C/C++/Java进程死锁分析
 
 ## 介绍
 
 deadlock-detect 用于C/C++/Java进程的死锁检测分析，帮助开发者在Linux系统下识别多线程死锁状态异常问题。
 
----
 
 ## 功能
 - 进程死锁检测
@@ -21,3 +22,24 @@ deadlock-detect 用于C/C++/Java进程的死锁检测分析，帮助开发者在
 
 #### 远程环境死锁检测
   执行ctrl+shift+p启动命令面板或者在编辑区域点击鼠标右键选择'C/C++/Java进程死锁检测'，选择`C/C++/Java进程死锁检测`，默认会打开一个页面，点击“远程检测”,按要求添加`进程Pid`、`远程用户`、`远程IP地址`、`远程登录密码`即可。
+
+# C/C++/Java Process deadlock analysis
+
+## Introduction
+
+deadlock-detect is a tool for deadlock detection and analysis in C/C++/Java processes, helping developers identify abnormal multi-threaded deadlock states on Linux systems.
+
+## Features
+- Process deadlock detection
+- Remote environment process deadlock detection
+
+## Usage
+#### Check dependencies
+    Depends on binutils, libc-bin, sshpass, libc6-dbg packages. Installation command: sudo apt install binutils libc-bin gdb sshpass libc6-dbg -y. Alternatively, use the extension-dependency package manager to check and install dependencies.
+
+#### Process deadlock detection
+    Open the command palette with ctrl+shift+p or right-click in the editor area and select C/C++/Java Process Deadlock Detection. Select C/C++/Java Process Deadlock Detection, and a page will open. Choose the type of deadlock, add the process PID, and >user password as required.
+
+#### Remote environment deadlock detection
+    Open the command palette with ctrl+shift+p or right-click in the editor area and select C/C++/Java Process Deadlock Detection. Select C/C++/Java Process Deadlock Detection, and a page will open. Click "Remote Detection" and add the process PID, remote user, remote IP address, and remote login password as required.
+