Skip to content

docs: improve compile documentation and add CI workflow #2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Hencyraj wants to merge 1 commit into
base: master
Choose a base branch
from
+53 −4
Open

docs: improve compile documentation and add CI workflow #2002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Build TNN

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

jobs:
build:
runs-on: ${{ matrix.os }}

strategy:
matrix:
os: [ubuntu-latest, macos-latest]

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Configure
run: |
mkdir build
cd build
cmake ..

- name: Build
run: |
cd build
cmake --build . --config Release
27 changes: 23 additions & 4 deletions doc/en/user/compile_en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
## Prerequisites

Before building TNN, make sure the following tools are installed:

- Git
- CMake (version 3.10 or higher)
- C++ Compiler:
- Linux: GCC 7 or newer
- macOS: Clang (Xcode Command Line Tools)
- Windows: MSVC 2019 or newer


# Compile

[中文版本](../../cn/user/compile.md)
Expand Down Expand Up @@ -73,6 +85,9 @@ cd <path_to_tnn>/scripts
After the compilation is completed, the corresponding `armeabi-v7a` library, the` arm64-v8a` library and the `include` header file are generated in the` release` directory of the current directory. <font color="#dd0000">Notice that add `-Wl,--whole-archive tnn -Wl,--no-whole-archive` to the project, if tnn static library is compiled</font>.

## III. Cross-Compile in Linux
### Description
This section is for cross-compiling TNN on x86 Linux hosts for ARM-based devices.


### 1. Environment requirements
#### Dependencies
Expand Down Expand Up @@ -114,7 +129,11 @@ Please see:
RKNPU Compilation Prerequisite in [FAQ](../faq_en.md#rknpu-compilation-prerequisite)RKNPU Compilation Prerequisite.

## IV. Compile(x86 Linux)
### 1. Enviromnment requirements

### Description
This section is for native compilation on x86 Linux systems.

### 1. Environment requirements
#### Dependencies
- cmake (version 3.11 or higher)

Expand Down Expand Up @@ -162,7 +181,7 @@ cd <path_to_tnn>/scripts
### 1. Environment requirements
#### Dependencies
- Visual Studio (version 2015 or higher)
- cmake (vsrsion 3.11 or higher; Or use build-in cmake in Visual Studio)
- cmake (version 3.11 or higher; Or use built-in cmake in Visual Studio)
- ninja (faster compilation, installed with chocolatey)

### 2. Compilation Steps
Expand All @@ -186,8 +205,8 @@ Openvino can only be compiled to 64-bit version. More problems refer to [FAQ](op
### 1. Environment requirements
#### Dependencies
- Visual Studio (version 2015 or higher)
- cmake (vsrsion 3.11 or higher; Or use build-in cmake in Visual Studio)
- CUDA (version 10.2 or higher) and make sure `CUDA_PATH` was set in Environment Virables
- cmake (vsrsion 3.11 or higher; Or use built-in cmake in Visual Studio)
- CUDA (version 10.2 or higher) and make sure `CUDA_PATH` was set in Environment Variables

#### TensorRT configuration
- Download TensorRT (version>=7.1) <https://developer.nvidia.com/nvidia-tensorrt-7x-download>
Expand Down