diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..1774e4b956702acd6e75f5570c9fbca7c25eddc0 --- /dev/null +++ b/README.en.md @@ -0,0 +1,47 @@ +# Mini Game + +This is a mini game project based on TypeScript, designed for showcasing open-source projects on the Gitee platform. + +## Project Overview + +This project is written in TypeScript and developed using Cocos Creator. It includes a basic framework and an asset management module, making it suitable for developing small-scale games. + +### Key Features +- Basic module management (`DmBaseModule`) +- View management (`DmBaseView`) +- Asset loading management (`DmAssetsManager`) +- Basic UI components (`UIBase`) + +## Installation Steps + +1. **Clone the Repository** + ```bash + git clone https://gitee.com/yph_1994/mini-game.git + ``` + +2. **Install Dependencies** + ```bash + npm install + ``` + +3. **Run the Project** + Open the project using Cocos Creator and run it. + +## Usage Instructions + +- **Asset Management**: Use `DmAssetsManager` to load and manage assets. +- **Module Development**: Inherit from `DmBaseModule` to create new functional modules. +- **UI Development**: Inherit from `DmBaseView` or `UIBase` to create view components. + +## Contribution Guide + +Code contributions and documentation improvements are welcome. Please follow these steps: +1. Fork the project +2. Create a new branch (`git checkout -b feature/new-feature`) +3. Commit your changes (`git commit -am 'Add new feature'`) +4. Push the branch (`git push origin feature/new-feature`) +5. Submit a Pull Request + +## License + +This project is licensed under the MIT License. For details, please refer to the LICENSE file included in the project. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..383981a6f70fde5731be93502888536a35e7aae0 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# Mini Game + +这是一个基于 TypeScript 的小游戏项目,适用于 Gitee 平台上的开源项目展示。 + +## 项目简介 + +该项目使用 TypeScript 编写,基于 Cocos Creator 开发,包含基础框架和资源管理模块,适合用于开发小型游戏。 + +### 主要功能 +- 基础模块管理(`DmBaseModule`) +- 视图管理(`DmBaseView`) +- 资源加载管理(`DmAssetsManager`) +- 基础 UI 组件(`UIBase`) + +## 安装步骤 + +1. **克隆仓库** + ```bash + git clone https://gitee.com/yph_1994/mini-game.git + ``` + +2. **安装依赖** + ```bash + npm install + ``` + +3. **运行项目** + 使用 Cocos Creator 打开项目并运行。 + +## 使用说明 + +- **资源管理**:使用 `DmAssetsManager` 加载和管理资源。 +- **模块开发**:继承 `DmBaseModule` 创建新的功能模块。 +- **UI 开发**:继承 `DmBaseView` 或 `UIBase` 创建视图组件。 + +## 贡献指南 + +欢迎贡献代码和改进文档。请遵循以下步骤: +1. Fork 项目 +2. 创建新分支 (`git checkout -b feature/new-feature`) +3. 提交更改 (`git commit -am 'Add new feature'`) +4. 推送分支 (`git push origin feature/new-feature`) +5. 提交 Pull Request + +## 许可证 + +本项目采用 MIT 许可证。详情请查看项目中的 LICENSE 文件。 \ No newline at end of file