diff --git a/README.md b/README.md index 404e3d38b..1ac6fd87d 100644 --- a/README.md +++ b/README.md @@ -75,57 +75,12 @@ MAA 正计划建设为一类项目，而非舟的单一软件。 ## 开发 -### 本地开发 +_请留意，仅当您准备开发 MaaFramework 本身时，才需要阅读本章节内容。若您仅希望基于 MaaFramework 开发自己的应用，则请参考 [即刻开始](#即刻开始)。_ -1. 下载 MaaDeps prebuilt - - ```sh - python3 tools/maadeps-download.py - ``` - -2. _(macOS only)_ 下载 fmt - - ```sh - sh tools/fetch-fmt.sh - ``` - -3. 配置 cmake - - - Windows - - ```bash - cmake --preset "MSVC 2022" - ``` - - - Linux / macOS - - ```bash - cmake --preset "NinjaMulti" - ``` - -4. 使用 cmake 构建工程 - - ```bash - cmake --build build --config Release - cmake --install build --prefix install - ``` - -生成的二进制及相关文件在 `install` 目录下。 - -详情请参考 [Build CI](https://github.com/MaaAssistantArknights/MaaFramework/blob/main/.github/workflows/build.yml). - -### 在线开发 - -使用 Codespaces (Dev Container) 一键配置基础开发环境 (Ninja、Cmake、g++-13)： - -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=632024122) - -随后按照 [本地开发](#本地开发) 流程进行配置。 +- [构建指南](docs/zh_cn/4.1-构建指南.md) ## 鸣谢 -### 开发者 - 感谢以下开发者对 MaaFramework 作出的贡献： diff --git a/README_en.md b/README_en.md index 4817e8997..2462b26ad 100644 --- a/README_en.md +++ b/README_en.md @@ -75,57 +75,12 @@ We also welcome adding your project to the best practices list above! ## Development -### Local Development +_Please note that you only need to read this chapter if you are ready to develop MaaFramework itself. If you only want to develop applications based on MaaFramework, please refer to [Get Started](#get-started)._ -1. Download MaaDeps prebuilt - - ```sh - python3 tools/maadeps-download.py - ``` - -2. _(macOS only)_ Download fmt - - ```sh - sh tools/fetch-fmt.sh - ``` - -3. Configure cmake - - - Windows - - ```bash - cmake --preset "MSVC 2022" - ``` - - - Linux / macOS - - ```bash - cmake --preset "NinjaMulti" - ``` - -4. Build the project using cmake - - ```bash - cmake --build build --config Release - cmake --install build --prefix install - ``` - -The generated binaries and related files are located in the `install` directory. - -For more details, refer to [Build CI](https://github.com/MaaAssistantArknights/MaaFramework/blob/main/.github/workflows/build.yml). - -### Online Development - -Use Codespaces (Dev Container) to set up the basic development environment with one click (Ninja, CMake, g++-13): - -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=632024122) - -Then follow the steps in [Local Development](#local-development). +- [How to build](docs/en_us/4.1-BuildGuide.md) ## Acknowledgments -### Developers - Thanks to the following developers for their contributions to MaaFramework: diff --git a/docs/en_us/4.1-BuildGuide.md b/docs/en_us/4.1-BuildGuide.md new file mode 100644 index 000000000..ec1655e7f --- /dev/null +++ b/docs/en_us/4.1-BuildGuide.md @@ -0,0 +1,50 @@ +# How to build + +_Please note that you only need to read this chapter if you are ready to develop MaaFramework itself. If you only want to develop applications based on MaaFramework, please refer to [Quick Started](1.1-QuickStarted.md)._ + +## Local Development + +1. Download MaaDeps prebuilt + + ```sh + python3 tools/maadeps-download.py + ``` + +2. _(macOS only)_ Download fmt + + ```sh + sh tools/fetch-fmt.sh + ``` + +3. Configure cmake + + - Windows + + ```bash + cmake --preset "MSVC 2022" + ``` + + - Linux / macOS + + ```bash + cmake --preset "NinjaMulti" + ``` + +4. Build the project using cmake + + ```bash + cmake --build build --config Release + cmake --install build --prefix install + ``` + +The generated binaries and related files are located in the `install` directory. + +For more details, refer to [Build CI](https://github.com/MaaAssistantArknights/MaaFramework/blob/main/.github/workflows/build.yml). + +## Online Development + +Use Codespaces (Dev Container) to set up the basic development environment with one click (Ninja, CMake, g++-13): + +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=632024122) + +Then follow the steps in [Local Development](#local-development). diff --git "a/docs/zh_cn/4.1-\346\236\204\345\273\272\346\214\207\345\215\227.md" "b/docs/zh_cn/4.1-\346\236\204\345\273\272\346\214\207\345\215\227.md" new file mode 100644 index 000000000..79632ccb4 --- /dev/null +++ "b/docs/zh_cn/4.1-\346\236\204\345\273\272\346\214\207\345\215\227.md" @@ -0,0 +1,50 @@ +# 构建指南 + +_请留意，仅当您准备开发 MaaFramework 本身时，才需要阅读本章节内容。若您仅希望基于 MaaFramework 开发自己的应用，则请参考 [快速开始](1.1-快速开始.md)。_ + +## 本地开发 + +1. 下载 MaaDeps prebuilt + + ```sh + python3 tools/maadeps-download.py + ``` + +2. _(macOS only)_ 下载 fmt + + ```sh + sh tools/fetch-fmt.sh + ``` + +3. 配置 cmake + + - Windows + + ```bash + cmake --preset "MSVC 2022" + ``` + + - Linux / macOS + + ```bash + cmake --preset "NinjaMulti" + ``` + +4. 使用 cmake 构建工程 + + ```bash + cmake --build build --config Release + cmake --install build --prefix install + ``` + +生成的二进制及相关文件在 `install` 目录下。 + +详情请参考 [Build CI](https://github.com/MaaAssistantArknights/MaaFramework/blob/main/.github/workflows/build.yml). + +## 在线开发 + +使用 Codespaces (Dev Container) 一键配置基础开发环境 (Ninja、Cmake、g++-13)： + +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=632024122) + +随后按照 [本地开发](#本地开发) 流程进行配置。