搭建代码框架并更新文档
This commit is contained in:
81
README_BUILD.md
Normal file
81
README_BUILD.md
Normal file
@@ -0,0 +1,81 @@
|
||||
# DisplayFlow 构建指南
|
||||
|
||||
## 前置要求
|
||||
|
||||
### Windows
|
||||
- CMake 3.15 或更高版本
|
||||
- Visual Studio 2019 或更高版本(包含 Windows SDK 10.0.19041.0+)
|
||||
- Git
|
||||
|
||||
### Android
|
||||
- CMake 3.15 或更高版本
|
||||
- Android NDK r21 或更高版本
|
||||
- Android Studio(可选,用于开发)
|
||||
|
||||
## 构建步骤
|
||||
|
||||
### Windows
|
||||
|
||||
```bash
|
||||
# 创建构建目录
|
||||
mkdir build
|
||||
cd build
|
||||
|
||||
# 配置 CMake
|
||||
cmake .. -G "Visual Studio 16 2019" -A x64
|
||||
|
||||
# 编译
|
||||
cmake --build . --config Release
|
||||
```
|
||||
|
||||
### Android
|
||||
|
||||
```bash
|
||||
# 创建构建目录
|
||||
mkdir build-android
|
||||
cd build-android
|
||||
|
||||
# 配置 CMake(需要设置 ANDROID_NDK 环境变量)
|
||||
cmake .. \
|
||||
-DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK/build/cmake/android.toolchain.cmake \
|
||||
-DANDROID_ABI=arm64-v8a \
|
||||
-DANDROID_PLATFORM=android-21
|
||||
|
||||
# 编译
|
||||
cmake --build .
|
||||
```
|
||||
|
||||
## 依赖管理
|
||||
|
||||
项目依赖将通过以下方式管理:
|
||||
|
||||
1. **FlatBuffers**:通过 Git Submodule 或 vcpkg 引入
|
||||
2. **编解码库**:使用平台原生 API(MediaCodec、Media Foundation)
|
||||
|
||||
## 开发环境设置
|
||||
|
||||
### 使用 vcpkg(推荐)
|
||||
|
||||
```bash
|
||||
# 安装 vcpkg
|
||||
git clone https://github.com/Microsoft/vcpkg.git
|
||||
cd vcpkg
|
||||
.\bootstrap-vcpkg.bat
|
||||
|
||||
# 安装依赖
|
||||
.\vcpkg install flatbuffers
|
||||
|
||||
# 配置 CMake 使用 vcpkg
|
||||
cmake .. -DCMAKE_TOOLCHAIN_FILE=[vcpkg root]/scripts/buildsystems/vcpkg.cmake
|
||||
```
|
||||
|
||||
## 测试
|
||||
|
||||
```bash
|
||||
# 启用测试
|
||||
cmake .. -DBUILD_TESTS=ON
|
||||
|
||||
# 运行测试
|
||||
ctest
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user