From 232ebd17c4615743ab9ccae2d838677b6647390d Mon Sep 17 00:00:00 2001 From: Horror Proton <107091537+horror-proton@users.noreply.github.com> Date: Thu, 2 Nov 2023 16:50:33 +0000 Subject: [PATCH] docs: add GitHub codespace to dev instructions --- ...2-\345\274\200\345\217\221\347\233\270\345\205\263.md" | 8 ++++++++ docs/en-us/2.2-DEVELOPMENT.md | 8 ++++++++ ...52\343\202\257\343\202\250\343\202\271\343\203\210.md" | 8 ++++++++ ...5_\352\265\254\354\266\225\355\225\230\352\270\260.md" | 8 ++++++++ ...2-\351\226\213\347\231\274\347\233\270\351\227\234.md" | 8 ++++++++ 5 files changed, 40 insertions(+) diff --git "a/docs/2.2-\345\274\200\345\217\221\347\233\270\345\205\263.md" "b/docs/2.2-\345\274\200\345\217\221\347\233\270\345\205\263.md" index 4fbd876d364..cae6f8ae366 100644 --- "a/docs/2.2-\345\274\200\345\217\221\347\233\270\345\205\263.md" +++ "b/docs/2.2-\345\274\200\345\217\221\347\233\270\345\205\263.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 index 935ffb46413..43c902ae879 100644 --- 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-\343\203\227\343\203\253\343\203\252\343\202\257\343\202\250\343\202\271\343\203\210.md" "b/docs/ja-jp/2.2-\343\203\227\343\203\253\343\203\252\343\202\257\343\202\250\343\202\271\343\203\210.md" index 0d27a4516a5..ebd55b0faf7 100644 --- "a/docs/ja-jp/2.2-\343\203\227\343\203\253\343\203\252\343\202\257\343\202\250\343\202\271\343\203\210.md" +++ "b/docs/ja-jp/2.2-\343\203\227\343\203\253\343\203\252\343\202\257\343\202\250\343\202\271\343\203\210.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-\352\260\234\353\260\234_\355\231\230\352\262\275_\352\265\254\354\266\225\355\225\230\352\270\260.md" "b/docs/ko-kr/2.2-\352\260\234\353\260\234_\355\231\230\352\262\275_\352\265\254\354\266\225\355\225\230\352\270\260.md" index 7fb5d2f8123..638402aae5e 100644 --- "a/docs/ko-kr/2.2-\352\260\234\353\260\234_\355\231\230\352\262\275_\352\265\254\354\266\225\355\225\230\352\270\260.md" +++ "b/docs/ko-kr/2.2-\352\260\234\353\260\234_\355\231\230\352\262\275_\352\265\254\354\266\225\355\225\230\352\270\260.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-\351\226\213\347\231\274\347\233\270\351\227\234.md" "b/docs/zh-tw/2.2-\351\226\213\347\231\274\347\233\270\351\227\234.md" index 21e7e05d1ca..718bc8d7ce8 100644 --- "a/docs/zh-tw/2.2-\351\226\213\347\231\274\347\233\270\351\227\234.md" +++ "b/docs/zh-tw/2.2-\351\226\213\347\231\274\347\233\270\351\227\234.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 工程