Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Xrysnow committed Mar 31, 2024
1 parent d066562 commit e7a3404
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 41 deletions.
41 changes: 20 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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+
Expand All @@ -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)\
Expand All @@ -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)
41 changes: 21 additions & 20 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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+
Expand All @@ -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)\
Expand All @@ -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)

0 comments on commit e7a3404

Please sign in to comment.