diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..463239502b5d38755f3966b6bb09c8e1b8e54986 --- /dev/null +++ b/README.en.md @@ -0,0 +1,54 @@ +# Buddy + +[English](./README.md) | [Chinese](./README_CN.md) + +## Project Overview + +This project is hosted on Gitee: https://gitee.com/whpa24soft/buddy + +## Project Structure + +``` +buddy/ +├── client.zip # Client-related files +└── dongyu02.zip # Core module files +``` + +## Features + +- Includes client components +- Includes core business modules +- Lightweight design + +## Installation Instructions + +### Prerequisites + +- Ensure the necessary runtime environment is installed +- Extract the required compressed files + +### Installation Steps + +1. Clone or download this repository +2. Extract `client.zip` to obtain the client files +3. Extract `dongyu02.zip` to obtain the core module files + +## Usage + +Refer to the specific documentation within each module for detailed usage instructions. + +## License + +For details on the project license, please refer to the LICENSE file (if available). + +## Contribution Guidelines + +Issues and Pull Requests are welcome! + +## Contact + +If you have any questions, please submit an Issue via Gitee. + +--- + +*This README is automatically generated based on the project repository structure.* \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..3bd66ac06ec8df2b9d56ab1c3f6ab7d544f90389 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# Buddy + +[English](./README.md) | [中文](./README_CN.md) + +## 项目简介 + +本项目托管于 Gitee: https://gitee.com/whpa24soft/buddy + +## 项目结构 + +``` +buddy/ +├── client.zip # 客户端相关文件 +└── dongyu02.zip # 核心模块文件 +``` + +## 功能特点 + +- 包含客户端组件 +- 包含核心业务模块 +- 轻量级设计 + +## 安装说明 + +### 前置要求 + +- 确保已安装必要的运行环境 +- 解压所需的压缩文件 + +### 安装步骤 + +1. 克隆或下载本仓库 +2. 解压 `client.zip` 获取客户端文件 +3. 解压 `dongyu02.zip` 获取核心模块文件 + +## 使用方法 + +请参考各模块内的具体文档获取详细使用说明。 + +## 许可证 + +本项目具体许可证请查看 LICENSE 文件(如果有)。 + +## 贡献指南 + +欢迎提交 Issue 和 Pull Request! + +## 联系方式 + +如有问题,请通过 Gitee 提交 Issue。 + +--- + +*此 README 基于项目仓库结构自动生成。* \ No newline at end of file