From e7a3404c7c48e972996a18f8137934fc6b659d34 Mon Sep 17 00:00:00 2001 From: Xrysnow Date: Sun, 31 Mar 2024 17:14:44 +0800 Subject: [PATCH] update readme --- README.md | 41 ++++++++++++++++++++--------------------- README_ZH.md | 41 +++++++++++++++++++++-------------------- 2 files changed, 41 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 531a705..f361743 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ Full release download: $ git clone --recursive https://github.com/Xrysnow/LuaSTG-x.git -2. Clone external libraries into `frameworks/cocos2d-x/external` (or download from [release page](https://github.com/Xrysnow/cocos2d-x-3rd-party-libs-bin/releases)). +2. For releases before 2023, clone external libraries into `frameworks/cocos2d-x/external` (or download from [release page](https://github.com/Xrysnow/cocos2d-x-3rd-party-libs-bin/releases)). $ cd LuaSTG-x/frameworks/cocos2d-x/external $ git clone --recursive https://github.com/Xrysnow/cocos2d-x-3rd-party-libs-bin.git @@ -60,7 +60,7 @@ Full release download: ## Build Requirements - CMake 3.20+ -- Android Studio 2020.3.1+ and NDK r22+ +- Android Studio 2021.1.1+ and NDK r22+ - Linux with compiler supports C++17 (Clang is recommended) - macOS 11.3+ and Xcode 13+ - Windows 7+ and VS 2019+ @@ -74,21 +74,32 @@ Runtime requirements is actually decided by your compiler, but in most cases the - macOS 10.15+ - Windows 7+ and visual c++ runtime -Note that iOS 13+ and macOS 10.15+ is always required for `std::filesystem` ([source](https://developer.apple.com/documentation/xcode-release-notes/xcode-11-release-notes)). +Note that iOS 13+ and macOS 10.15+ are always required for `std::filesystem` ([source](https://developer.apple.com/documentation/xcode-release-notes/xcode-11-release-notes)). ## Dependency Graph LuaSTG-x\ -├　[cocos2d-x](https://github.com/Xrysnow/cocos2d-x)\ -│　　└ [cocos2d-x-3rd-party-libs-bin](https://github.com/Xrysnow/cocos2d-x-3rd-party-libs-bin)\ +├　[cocos-x](https://github.com/Xrysnow/cocos-x)\ +│　　└ [cocos-x-external](https://github.com/Xrysnow/cocos-x-external)\ │　　　　├ [cocos2d-x-gfx](https://github.com/Xrysnow/cocos2d-x-gfx)\ -│　　　　└ [openal-soft](https://github.com/kcat/openal-soft)\ +│　　　　├ [glslang](https://github.com/KhronosGroup/glslang)\ +│　　　　├ [openal-soft](https://github.com/kcat/openal-soft)\ +│　　　　└ [SPIRV-Cross](https://github.com/KhronosGroup/SPIRV-Cross)\ +├　[cocos2d-x-imgui](https://github.com/Xrysnow/cocos2d-x-imgui)\ +│　　├ [ImGui](https://github.com/ocornut/imgui)\ +│　　├ [imgui_markdown](https://github.com/juliettef/imgui_markdown)\ +│　　├ [ImGuiColorTextEdit](https://github.com/Xrysnow/ImGuiColorTextEdit)\ +│　　└ [implot](https://github.com/epezent/implot)\ +├　[cocos2d-x-live2d](https://github.com/Xrysnow/cocos2d-x-live2d) (optional)\ +│　├ [CubismNativeFramework](https://github.com/Live2D/CubismNativeFramework)\ +│　└ [Cubism SDK for Native](https://www.live2d.com/en/download/cubism-sdk/download-native)\ +├　[cocos2d-x-video](https://github.com/Xrysnow/cocos2d-x-video)\ +│　　└ [FFmpeg](http://ffmpeg.org) (in lstgx_external)\ ├　[lstgx_Audio](https://github.com/Xrysnow/lstgx_Audio)\ -│　　└ [openal-soft](https://github.com/kcat/openal-soft) (in cocos2d-x-3rd-party-libs-bin)\ +│　　└ [openal-soft](https://github.com/kcat/openal-soft) (in cocos-x-external)\ ├　[lstgx_external](https://github.com/Xrysnow/lstgx_external)\ │　　├ [ANGLE](https://github.com/google/angle) (optional)\ │　　├ [BurstLinker](https://github.com/Xrysnow/BurstLinker)\ -│　　├ [FairyGUI](https://github.com/fairygui/FairyGUI-cocos2dx) (optional)\ │　　├ [FFmpeg](http://ffmpeg.org) (optional)\ │　　├ [libzippp](https://github.com/ctabin/libzippp)\ │　　│　└ [libzip](https://github.com/nih-at/libzip)\ @@ -98,18 +109,6 @@ LuaSTG-x\ │　　├ [MicroTeX](https://github.com/Xrysnow/MicroTeX)\ │　　├ [nanosvg](https://github.com/memononen/nanosvg)\ │　　├ [NativeFileDialog](https://github.com/mlabbe/nativefiledialog)\ -│　　├ [yasio](https://github.com/yasio/yasio) (optional)\ │　　└ [Yuescript](https://github.com/pigpigyyy/Yuescript) (optional)\ ├　[lstgx_Math](https://github.com/Xrysnow/lstgx_Math)\ -├　[lstgx_LuaCore](https://github.com/Xrysnow/lstgx_LuaCore)\ -├　[cocos2d-x-imgui](https://github.com/Xrysnow/cocos2d-x-imgui)\ -│　　├ [ImGui](https://github.com/ocornut/imgui)\ -│　　├ [imgui_markdown](https://github.com/juliettef/imgui_markdown)\ -│　　├ [ImGuiColorTextEdit](https://github.com/Xrysnow/ImGuiColorTextEdit)\ -│　　└ [implot](https://github.com/epezent/implot)\ -├　[cocos2d-x-live2d](https://github.com/Xrysnow/cocos2d-x-live2d) (optional)\ -│　├ [CubismNativeFramework](https://github.com/Live2D/CubismNativeFramework)\ -│　└ [Cubism SDK for Native](https://www.live2d.com/en/download/cubism-sdk/download-native)\ -├　[cocos2d-x-video](https://github.com/Xrysnow/cocos2d-x-video)\ -│　　└ [FFmpeg](http://ffmpeg.org) (in lstgx_external)\ -└　[creator_to_cocos2dx](https://github.com/Xrysnow/creator_to_cocos2dx) +└　[lstgx_LuaCore](https://github.com/Xrysnow/lstgx_LuaCore) diff --git a/README_ZH.md b/README_ZH.md index b940263..852b2e8 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -41,7 +41,7 @@ LuaSTG-x 是一个基于 [cocos2d-x](https://github.com/cocos2d/cocos2d-x) 和 [ $ git clone --recursive https://github.com/Xrysnow/LuaSTG-x.git -2. 克隆外部库至 `frameworks/cocos2d-x/external` （或从 [release 页面](https://github.com/Xrysnow/cocos2d-x-3rd-party-libs-bin/releases) 下载） +2. 对于2023年之前的版本，克隆外部库至 `frameworks/cocos2d-x/external` （或从 [release 页面](https://github.com/Xrysnow/cocos2d-x-3rd-party-libs-bin/releases) 下载） $ cd LuaSTG-x/frameworks/cocos2d-x/external $ git clone --recursive https://github.com/Xrysnow/cocos2d-x-3rd-party-libs-bin.git @@ -60,7 +60,7 @@ LuaSTG-x 是一个基于 [cocos2d-x](https://github.com/cocos2d/cocos2d-x) 和 [ ## 编译要求 - CMake 3.20+ -- Android Studio 2020.3.1+ 和 NDK r22+ +- Android Studio 2021.1.1+ 和 NDK r22+ - 编译器支持 C++17 的 Linux (推荐使用Clang) - macOS 11.3+ 和 Xcode 13+ - Windows 7+ 和 VS 2019+ @@ -74,19 +74,32 @@ LuaSTG-x 是一个基于 [cocos2d-x](https://github.com/cocos2d/cocos2d-x) 和 [ - macOS 10.15+ - Windows 7+ 和 visual c++ 运行时 +注意，iOS 13+ 和 macOS 10.15+ 是必须的，因为需要使用 `std::filesystem` （[来源](https://developer.apple.com/documentation/xcode-release-notes/xcode-11-release-notes)）。 + ## 依赖图 LuaSTG-x\ -├　[cocos2d-x](https://github.com/Xrysnow/cocos2d-x)\ -│　　└ [cocos2d-x-3rd-party-libs-bin](https://github.com/Xrysnow/cocos2d-x-3rd-party-libs-bin)\ +├　[cocos-x](https://github.com/Xrysnow/cocos-x)\ +│　　└ [cocos-x-external](https://github.com/Xrysnow/cocos-x-external)\ │　　　　├ [cocos2d-x-gfx](https://github.com/Xrysnow/cocos2d-x-gfx)\ -│　　　　└ [openal-soft](https://github.com/kcat/openal-soft)\ +│　　　　├ [glslang](https://github.com/KhronosGroup/glslang)\ +│　　　　├ [openal-soft](https://github.com/kcat/openal-soft)\ +│　　　　└ [SPIRV-Cross](https://github.com/KhronosGroup/SPIRV-Cross)\ +├　[cocos2d-x-imgui](https://github.com/Xrysnow/cocos2d-x-imgui)\ +│　　├ [ImGui](https://github.com/ocornut/imgui)\ +│　　├ [imgui_markdown](https://github.com/juliettef/imgui_markdown)\ +│　　├ [ImGuiColorTextEdit](https://github.com/Xrysnow/ImGuiColorTextEdit)\ +│　　└ [implot](https://github.com/epezent/implot)\ +├　[cocos2d-x-live2d](https://github.com/Xrysnow/cocos2d-x-live2d) (optional)\ +│　├ [CubismNativeFramework](https://github.com/Live2D/CubismNativeFramework)\ +│　└ [Cubism SDK for Native](https://www.live2d.com/en/download/cubism-sdk/download-native)\ +├　[cocos2d-x-video](https://github.com/Xrysnow/cocos2d-x-video)\ +│　　└ [FFmpeg](http://ffmpeg.org) (in lstgx_external)\ ├　[lstgx_Audio](https://github.com/Xrysnow/lstgx_Audio)\ -│　　└ [openal-soft](https://github.com/kcat/openal-soft) (in cocos2d-x-3rd-party-libs-bin)\ +│　　└ [openal-soft](https://github.com/kcat/openal-soft) (in cocos-x-external)\ ├　[lstgx_external](https://github.com/Xrysnow/lstgx_external)\ │　　├ [ANGLE](https://github.com/google/angle) (optional)\ │　　├ [BurstLinker](https://github.com/Xrysnow/BurstLinker)\ -│　　├ [FairyGUI](https://github.com/fairygui/FairyGUI-cocos2dx) (optional)\ │　　├ [FFmpeg](http://ffmpeg.org) (optional)\ │　　├ [libzippp](https://github.com/ctabin/libzippp)\ │　　│　└ [libzip](https://github.com/nih-at/libzip)\ @@ -96,18 +109,6 @@ LuaSTG-x\ │　　├ [MicroTeX](https://github.com/Xrysnow/MicroTeX)\ │　　├ [nanosvg](https://github.com/memononen/nanosvg)\ │　　├ [NativeFileDialog](https://github.com/mlabbe/nativefiledialog)\ -│　　├ [yasio](https://github.com/yasio/yasio) (optional)\ │　　└ [Yuescript](https://github.com/pigpigyyy/Yuescript) (optional)\ ├　[lstgx_Math](https://github.com/Xrysnow/lstgx_Math)\ -├　[lstgx_LuaCore](https://github.com/Xrysnow/lstgx_LuaCore)\ -├　[cocos2d-x-imgui](https://github.com/Xrysnow/cocos2d-x-imgui)\ -│　　├ [ImGui](https://github.com/ocornut/imgui)\ -│　　├ [imgui_markdown](https://github.com/juliettef/imgui_markdown)\ -│　　├ [ImGuiColorTextEdit](https://github.com/Xrysnow/ImGuiColorTextEdit)\ -│　　└ [implot](https://github.com/epezent/implot)\ -├　[cocos2d-x-live2d](https://github.com/Xrysnow/cocos2d-x-live2d) (optional)\ -│　├ [CubismNativeFramework](https://github.com/Live2D/CubismNativeFramework)\ -│　└ [Cubism SDK for Native](https://www.live2d.com/en/download/cubism-sdk/download-native)\ -├　[cocos2d-x-video](https://github.com/Xrysnow/cocos2d-x-video)\ -│　　└ [FFmpeg](http://ffmpeg.org) (in lstgx_external)\ -└　[creator_to_cocos2dx](https://github.com/Xrysnow/creator_to_cocos2dx) +└　[lstgx_LuaCore](https://github.com/Xrysnow/lstgx_LuaCore)