Skip to content

Commit 8659821

Browse files
committed
docs: add BUILD.md
1 parent bc35d2e commit 8659821

3 files changed

Lines changed: 36 additions & 52 deletions

File tree

README.md

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -29,33 +29,9 @@ Pre-built versions can be downloaded from the [Release](https://github.com/flpfl
2929

3030
If you want the latest development version, you can also download it from the [CI](https://github.com/flpflan/u-freecam/actions) build artifacts.
3131

32-
## Build (Windows)
32+
## Build
3333

34-
### Requirement
35-
36-
- Visual Studio (With C++ toolchain and CMake)
37-
38-
### Compile
39-
40-
Open this project directly in Visual Studio, select the `freecam-x86_64-windows` target, and then generate it.
41-
42-
## Build (Android)
43-
44-
### Requirement
45-
46-
- Android NDK 27+
47-
- Cmake 3.22+
48-
- Ninja (Optional)
49-
50-
### Compile
51-
52-
```shell
53-
export ANDROID_NDK=/path/to/ndk # Set the path to Android NDK
54-
export GENERATOR=Ninja
55-
make release-aarch64 # Or the other target, e.g. release-x86_64
56-
```
57-
58-
output: `build/release-android-aarch64/libfreecam-aarch64-android.so`
34+
[docs/BUILD.md](/docs/BUILD.md)
5935

6036
## How to Use
6137

README.zh-CN.md

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -28,33 +28,9 @@ u-freecam
2828
可在 [Release](https://github.com/flpflan/u-freecam/releases) 页面下载预构建版本。
2929
如果你想获取最新的开发版本,也可从 [CI](https://github.com/flpflan/u-freecam/actions) 构建产物中下载。
3030

31-
## 构建 (Windows)
31+
## 构建
3232

33-
### 前置需求
34-
35-
- Visual Studio (包含 C++ 工具链和 CMake)
36-
37-
### 编译
38-
39-
用 Visual Studio 打开本项目,选择 `freecam-x86_64-windows` 目标,然后生成。
40-
41-
## 构建 (Android)
42-
43-
### 前置需求
44-
45-
- Android NDK 27+
46-
- Cmake 3.22+
47-
- Ninja (可选)
48-
49-
### 编译
50-
51-
```shell
52-
export ANDROID_NDK=/path/to/ndk # 设置 NDK 路径
53-
export GENERATOR=Ninja
54-
make release-aarch64 # 或者其它目标,如 release-x86_64
55-
```
56-
57-
输出: `build/release-android-aarch64/libfreecam-aarch64-android.so`
33+
[docs/BUILD.md](/docs/BUILD.md)
5834

5935
## 如何使用
6036

docs/BUILD.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Build
2+
3+
## Windows
4+
5+
### Requirements
6+
7+
- Visual Studio (with C++ workload and CMake support)
8+
9+
### Build
10+
11+
Open the project in Visual Studio and build the `freecam-x86_64-windows` target.
12+
13+
## Android
14+
15+
### Requirements
16+
17+
- Android NDK 27+
18+
- Cmake 3.22+
19+
- Ninja (Optional)
20+
21+
### Build
22+
23+
```shell
24+
export ANDROID_NDK=/path/to/ndk
25+
export GENERATOR=Ninja
26+
27+
make release-aarch64
28+
# or: release-x86_64, debug-aarch64, debug-x86_64
29+
```
30+
31+
output: `build/release-android-aarch64/libfreecam-aarch64-android.so`
32+

0 commit comments

Comments
 (0)