docs: add GitHub codespace to dev instructions

horror-proton · Nov 2, 2023 · 232ebd1 · 232ebd1
1 parent cae5b31
commit 232ebd1
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 0 deletions.
diff --git a/docs/2.2-开发相关.md b/docs/2.2-开发相关.md
@@ -100,3 +100,11 @@ icon: iconoir:developer
 你也可以使用 `tools\ClangFormatter\clang-formatter.py` 来直接调用你的 clang-format 来进行格式化，只需要在项目根目录下执行：
 
 - `python tools\ClangFormatter\clang-formatter.py --clang-format=PATH\TO\YOUR\clang-format.exe --input=src\MaaCore`
+
+## 使用 GitHub codespace 进行在线开发
+
+创建 GitHub codespace 自动配置 C++ 开发环境
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg?color=green)](https://codespaces.new/MaaAssistantArknights/MaaAssistantArknights)
+
+随后根据 vscode 的提示或 [Linux 教程](./2.1-Linux编译教程.md) 配置 GCC 12 和 CMake 工程
diff --git a/docs/en-us/2.2-DEVELOPMENT.md b/docs/en-us/2.2-DEVELOPMENT.md
@@ -85,3 +85,11 @@ You are all set with the clang-format integrated in Visual Studio supporting c++
 You can also format with `tools\ClangFormatter\clang-formatter.py` directly, by executing in the root folder of the project:
 
 - `python tools\ClangFormatter\clang-formatter.py --clang-format=PATH\TO\YOUR\clang-format.exe --input=src\MaaCore`
+
+## Develop in cloud using GitHub codespace
+
+Create GitHub codespace with pre configured C++ dev envirinments:
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg?color=green)](https://codespaces.new/MaaAssistantArknights/MaaAssistantArknights)
+
+Then follow the instructions in vscode or [Linux tutorial](./2.1-LINUX_TUTORIAL.md) to configure GCC 12 and the CMake project.
diff --git a/docs/ja-jp/2.2-プルリクエスト.md b/docs/ja-jp/2.2-プルリクエスト.md
@@ -71,3 +71,11 @@
 - `python tools\ClangFormatter\clang-formatter.py --clang-format=PATH\TO\YOUR\clang-format.exe --input=src\MaaCore`
 
 を実行するだけです。
+
+## Develop in cloud using GitHub codespace
+
+Create GitHub codespace with pre configured C++ dev envirinments:
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg?color=green)](https://codespaces.new/MaaAssistantArknights/MaaAssistantArknights)
+
+Then follow the instructions in vscode or Linux tutorial to configure GCC 12 and the CMake project.
diff --git a/docs/ko-kr/2.2-개발_환경_구축하기.md b/docs/ko-kr/2.2-개발_환경_구축하기.md
@@ -80,3 +80,11 @@ C++20 기능을 지원하는 Visual Studio에 통합된 클랑 형식으로 모
 또한 `tools\ClangFormatter\clang-formatter.py` 를 사용하여 포맷할 수 있습니다. 프로젝트의 루트 폴더에서 다음 명령줄을 실행하세요.
 
 - `python tools\ClangFormatter\clang-formatter.py --clang-format=PATH\TO\YOUR\clang-format.exe --input=src\MaaCore`
+
+## Develop in cloud using GitHub codespace
+
+Create GitHub codespace with pre configured C++ dev envirinments:
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg?color=green)](https://codespaces.new/MaaAssistantArknights/MaaAssistantArknights)
+
+Then follow the instructions in vscode or Linux tutorial to configure GCC 12 and the CMake project.
diff --git a/docs/zh-tw/2.2-開發相關.md b/docs/zh-tw/2.2-開發相關.md
@@ -102,3 +102,11 @@ icon: iconoir:developer
 你也可以使用 `tools\ClangFormatter\clang-formatter.py` 來直接調用你的 clang-format 來進行格式化，只需要在項目根目錄下執行：
 
 - `python tools\ClangFormatter\clang-formatter.py --clang-format=PATH\TO\YOUR\clang-format.exe --input=src\MaaCore`
+
+## ## 使用 GitHub codespace 進行線上開發
+
+建立 GitHub codespace 自動配置 C++ 開發環境
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg?color=green)](https://codespaces.new/MaaAssistantArknights/MaaAssistantArknights)
+
+隨後根據 vscode 的提示或 [Linux 教程](./2.1-Linux編譯教學.md) 配置 GCC 12 和 CMake 工程