Set up the TEN Framework development environment

This guide explains how to set up your development environment for the TEN Framework. The TEN Framework supports Windows, Linux, and Mac, with Linux or Mac recommended.

Linux setup

For Ubuntu, install the following packages:

• gcc - C/C++ compiler supported by TEN
• clang - Alternative C/C++ compiler
• clang-format - Code formatting tool used during runtime
• clang-tidy - Static code analyzer
• cmake - Build system (version 3.13+)
• Python3 - Required for Python binding
• pytest - Used for integration testing

Mac setup

Required components:

• XCode
• CocoaPods
• Personal Account

Install dependencies:

brew install llvm googletest doxygen ninja clang-format
brew install include-what-you-use

If the brew-installed cmake is outdated, install from the official website and create a symbolic link:

ln -s /Applications/CMake.app/Contents/bin/cmake /usr/local/bin/cmake

If cmake can't find clang-tidy, use:

ln -sf /usr/local/opt/llvm/bin/clang-tidy /usr/local/bin/clang-tidy

For language bindings, install:

brew install python golang

Windows setup

Install these components:

• Visual Studio Community (up to 2022)
  • Select clang-related tools
  • Add clang binary path to the PATH environment variable
• cmake
• python

Build system setup

ten_gn

TEN uses ten_gn as its build system (based on Google GN). The source code is in the core/ten_gn directory of the TEN Framework repository. Add this directory to your system PATH.

Docker containers

For a pre-configured build environment, we provide Docker files.

Ubuntu 22.04

Navigate to tools/docker_for_building/ubuntu/22.04 and run:

docker-compose up -d
docker-compose run ten-building-ubuntu-2204