From 5c1524f08699772866a3ed490ce54c0a65603b02 Mon Sep 17 00:00:00 2001
From: YiXuan Ding <1328032567@qq.com>
Date: Fri, 25 Oct 2024 16:05:44 +0800
Subject: [PATCH] <create>: create a readme file to describe files feature.

---
 tool/readme.txt | 63 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 tool/readme.txt

diff --git a/tool/readme.txt b/tool/readme.txt
new file mode 100644
index 0000000..9d2cc07
--- /dev/null
+++ b/tool/readme.txt
@@ -0,0 +1,63 @@
+###########################################################################
+# Chsrc 相关工具
+# 脚本工具
+###########################################################################
+
+************
+1. 概述
+************
+
+此文件夹包含许多与安装 Chsrc 二进制文件相关的脚本工具，您可以使用这些工具指定目录路径和发布版本。
+
+********
+2. 文件
+********
+
+install.sh          Bash 安装工具（中文版）。
+install-en.sh       Bash 安装工具（英文版）。
+install.ps1         Powershell 安装工具。
+reademe.txt         此文件
+
+*******************
+3. 安装
+*******************
+
+步骤1：输入“sudo chmod u+x ./install.sh”以使脚本可执行。
+
+步骤2：输入“./install.sh [-h] [-d <install_directory>] [-v <version>]”指定安装路径和发布版本。
+
+步骤3：如果出现错误，请检查您的网络连接并确保您可以访问Gitee。
+
+
+
+#####################################################################
+# Chsrc realated tools
+# Scripts Tools
+# English Version
+#####################################################################
+
+************
+1. Overview
+************
+
+This folder contains many script tools realated to install Chsrc binary file, 
+you can use the tools to specify directory path and release version.
+
+********
+2. Files
+********
+
+install.sh                  Bash install tool(Chinese Version).
+install-en.sh               Bash install tool(English Version).
+install.ps1                 Powershell install tool.
+reademe.txt                 This file
+
+*******************
+3. Install
+*******************
+
+Step 1: Type "sudo chmod u+x ./install.sh" to make scrpit executable.
+
+Step 2: Type "./install.sh [-h] [-d <install_directory>] [-v <version>]" to specify install path and release version.
+
+Step 3: If an error occurs, please check your internet connection and ensure that you can access Gitee.
\ No newline at end of file