From 149c8a7817c84ee8e284c98dfc170fc5c5d9b37c Mon Sep 17 00:00:00 2001
From: typhoonow <lijiawei40@hisilicon.com>
Date: Thu, 26 Jun 2025 16:29:46 +0800
Subject: [PATCH] update README

---
 README    | 20 --------------------
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 46 insertions(+), 20 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index a6d8a5c..0000000
--- a/README
+++ /dev/null
@@ -1,20 +0,0 @@
-iTrustee SDK
-============
-
-Getting Started
----------------
-Before setup your own project, please download libboundscheck software for secure function library.
-Decompress the openeuler-libboundscheck-master.zip package, then put this software to thirdparty/open_source path.
-Ensure that the header file path is thirdparty/open_source/libboundscheck/include.
-This software download address is https://gitee.com/openeuler/libboundscheck.
-
-build demo project:
-$ cd test/CA/helloworld
-$ make
-$ cd test/TA/helloworld
-$ make
-copy build result CA executable file and TA binary(xxx.sec) to /var/itrustee/ta
-#the path "/vendor/bin/" may be changed as your opinion, make sure it consistent with the path defined in your TA's source code
-$ /vendor/bin/demo_hello
-
-for more details please refor "iTrustee SDK�������ֲ�.chm"
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5b14836
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# iTrustee SDK
+
+#### 介绍
+itrustee sdk是指开发人发人员基于安全OS编译TA时所依赖的接口、函数库等。
+
+#### 操作系统
+支持ARM服务器，比如鲲鹏920。
+
+#### 编译教程
+
+1）下载libboundscheck库，下载地址：<https://gitee.com/openeuler/libboundscheck> 。
+
+2）将libboundscheck解压到**thirdparty/open_source**目录。
+
+3）通过以下命令可编译demo TA：
+
+```
+cd test/CA/helloworld
+make
+cd test/TA/helloworld
+make
+```
+
+4)也可通过cmake的方式编译TA:
+
+```
+cd test/TA/helloworld
+bash config.sh
+```
+
+5）将编译出来的TA二进制文件(xxx.sec)拷贝到服务器的/var/itrustee/ta目录下。
+
+6）将编译出来的CA拷贝到服务器的/vendor/bin目录下。（ca的执行路径可能会随着用户配置发生变化，请确保CA的执行路径与TA中配置的路径一致）
+
+7）执行demo CA：
+
+```
+/vendor/bin/demo_hello
+```
+
+#### 使用说明
+更多细节请参考"iTrustee SDKֲ.chm"。
+
+#### 参与贡献
+    如果您想为本仓库贡献代码，请向本仓库任意maintainer发送邮件
+    如果您找到产品中的任何Bug，欢迎您提出ISSUE
-- 
Gitee