Repository files navigation

Support this project bybecoming a sponsor. Your logo will show up here with a link to your website. 🙏

You can also consider sponsoring us to get extra technical support services via theGithub sponsor program. If you do, you can get access to thexmake-io/technical-support repository, which has the following bennefits:

• Handling Issues with higher priority
• One-to-one technical consulting service
• Review your xmake.lua and provide suggestions for improvement

What is Xmake?

1. Xmake is a cross-platform build utility based on the Lua scripting language.
2. Xmake is very lightweight and has no dependencies outside of the standard library.
3. Uses thexmake.lua file to maintain project builds with a simple and readable syntax.

Xmake can be used to directly build source code (like with Make or Ninja), or it can generate project source files like CMake or Meson. It also has abuilt-in package management system to help users integrate C/C++ dependencies.

Xmake = Build backend + Project Generator + Package Manager + [Remote|Distributed] Build + Cache

Although less precise, one can still understand Xmake in the following way:

Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache

If you want to know more, please refer to: theDocumentation,GitHub orGitee. You are also welcome to join ourcommunity.

The official Xmake repository can be found atxmake-io/xmake-repo.

curl -fsSL https://xmake.io/shget.text| bash

wget https://xmake.io/shget.text -O -| bash

Invoke-Expression (Invoke-Webrequest'https://xmake.io/psget.text' -UseBasicParsing).Content

If you don't want to use the above scripts to install Xmake, visit theInstallation Guide for other installation methods (building from source, package managers, etc.).

target("console")set_kind("binary")add_files("src/*.c")

Creates a new targetconsole of kindbinary, and adds all the files ending in.c in thesrc directory.

add_requires("tbox 1.6.*","zlib","libpng ~1.6")

Adds a requirement of tbox v1.6, zlib (any version), and libpng v1.6.

The official xmake package repository exists at:xmake-repo

The below assumes you are currently in the project's root directory.

$ xmake

$ xmake run console

$ xmake run -d console

$ xmake f -p [windows|linux|macosx|android|iphoneos ..] -a [x86|arm64 ..] -m [debug|release]$ xmake

$ xmake f --menu

• Windows (x86, x64)
• macOS (i386, x86_64, arm64)
• Linux (i386, x86_64, cross-toolchains ..)
• *BSD (i386, x86_64)
• Android (x86, x86_64, armeabi, armeabi-v7a, arm64-v8a)
• iOS (armv7, armv7s, arm64, i386, x86_64)
• WatchOS (armv7k, i386)
• AppleTVOS (armv7, arm64, i386, x86_64)
• MSYS (i386, x86_64)
• MinGW (i386, x86_64, arm, arm64)
• Cygwin (i386, x86_64)
• Wasm (wasm32)
• Cross (cross-toolchains ..)

• Xcode
• MSVC (Microsoft Visual C compiler)
• Android NDK

• Zig
• Go(lang)
• Swift
• Nim
• Rust
• GCC (GNU Compiler Collection)
• Clang
• TinyCC
• icc (Intel C Compiler)
• icpc (Intel C++ Compiler)
• icx (Intel LLVM C/C++ Compiler)
• Clang-CL (Clang Compatability with MSVC)
• DPC++ (Intel LLVM C++ Compiler using SYCL)
• MinGW (GNU for Windows)
• C51 (Keil C Compiler for the 8051)
• GNU-RM (GNU Arm Embedded Toolchain)
• ArmCC (Keil C Compiler for Keil MKD Version 5)
• Circle (New C++20 compiler)
• WASI (C/C++ WebAssembly Toolchain)
• ArmClang (Version 6 of the Keil MDK)
• SDCC (Small Device C Compiler)
• GDC (GNU D Compiler)
• LDC (LLVM D Compiler)
• DMD (Dlang)
• FPC (Free Pascal Programming Language Compiler)
• GFortran (GNU Fortran Compiler)
• Ifort (Intel Fortran Compiler)
• CUDA (nvcc, nvc, nvc++, nvfortran)
• Emscripten
• LLVM
• Icarus Verilog
• Verilator (SystemVerilog simulator and lint system)

• FASM
• NASM
• YASM
• MASM32 (Microsoft Macro Assembler 32-bit SDK)

• C, C++ (including cpp2)
• Objective-C and Objective-C++
• Swift
• Assembly
• Golang
• Rust
• Dlang
• Fortran
• Cuda
• Zig
• Vala
• Pascal
• Nim
• Verilog
• FASM
• NASM
• YASM
• MASM32

Xmake exhibits:

• Simple yet flexible configuration grammar.
• Quick, dependency-free installation.
• Easy compilation for most all supported platforms.
• Supports cross-compilation with intelligent analysis of cross toolchain information.
• Extremely fast parallel compilation support.
• Supports C++ modules (new in C++20).
• Supports cross-platform C/C++ dependencies with built-in package manager.
• Multi-language compilation support including mixed-language projects.
• Rich plug-in support with various project generators (ex. Visual Studio/Makefiles/CMake/compile_commands.json)
• REPL interactive execution support
• Incremental compilation support with automatic analysis of header files
• Built-in toolchain management
• A large number of expansion modules
• Remote compilation support
• Distributed compilation support
• Local and remote build cache support

Xmake supports the below types of projects:

• Static libraries
• Shared libraries
• Console/CLI applications
• CUDA programs
• Qt applications
• WDK drivers (umdf/kmdf/wdm)
• WinSDK applications
• MFC applications
• Darwin applications (with metal support)
• Frameworks and bundles (in Darwin)
• SWIG modules (Lua, Python, ...)
• LuaRocks modules
• Protobuf programs
• Lex/Yacc programs
• Linux kernel modules

Xmake can automatically fetch and install dependencies!

• Official package repositoryxmake-repo (tbox >1.6.1)
• Official package managerXrepo
• User-built repositories
• Conan (conan::openssl/1.1.1g)
• Conda (conda::libpng 1.3.67)
• Vcpkg (vcpkg::ffmpeg)
• Homebrew/Linuxbrew (brew::pcre2/libpcre2-8)
• Pacman on archlinux/msys2 (pacman::libcurl)
• Apt on ubuntu/debian (apt::zlib1g-dev)
• Clib (clib::clibs/bytes@0.0.4)
• Dub (dub::log 0.4.3)
• Portage on Gentoo/Linux (portage::libhandy)
• Nimble for nimlang (nimble::zip >1.3)
• Cargo for rust (cargo::base64 0.13.0)

• The official repository provides nearly 500+ packages with simple compilation on all supported platforms
• Full platform package support, support for cross-compiled dependent packages
• Support package virtual environment usingxrepo env shell
• Precompiled package acceleration for Windows (NT)
• Support self-built package repositories and private repository deployment
• Third-party package repository support for repositories such as: vcpkg, conan, conda, etc.
• Supports automatic pulling of remote toolchains
• Supports dependency version locking

Below is a diagram showing roughly the architecture of Xmake, and thus how it functions.

• Cross-platform support.
• Support for MSVC, Clang, GCC and other cross-compilation toolchains.
• Support for building for Android, Linux, Windows NT, and Darwin hosts.
• No dependencies other than the compilation toolchain.
• Support for build server load balancing scheduling.
• Support for real time compressed transfer of large files (lz4).
• Almost zero configuration cost, no shared filesystem required, for convenience and security.

For more details see:#274

For more details see:#622

For more details see:#622

Xmake's speed on is par with Ninja! The test project:xmake-core

add_rules("mode.debug","mode.release")target("console")set_kind("binary")add_files("src/*.c")ifis_mode("debug")thenadd_defines("DEBUG")end

target("test")set_kind("binary")add_files("src/*.c")after_build(function (target)print("hello: %s",target:name())os.exec("echo %s",target:targetfile())end)

Download and use packages inxmake-repo or third-party repositories:

add_requires("tbox >1.6.1","libuv master","vcpkg::ffmpeg","brew::pcre2/libpcre2-8")add_requires("conan::openssl/1.1.1g", {alias="openssl",optional=true,debug=true})target("test")set_kind("binary")add_files("src/*.c")add_packages("tbox","libuv","vcpkg::ffmpeg","brew::pcre2/libpcre2-8","openssl")

In addition, we can also use thexrepo command to quickly install dependencies.

target("test")add_rules("qt.quickapp")add_files("src/*.cpp")add_files("src/qml.qrc")

target("test")set_kind("binary")add_files("src/*.cu")add_cugencodes("native")add_cugencodes("compute_35")

target("echo")add_rules("wdk.driver","wdk.env.umdf")add_files("driver/*.c")add_files("driver/*.inx")add_includedirs("exe")target("app")add_rules("wdk.binary","wdk.env.umdf")add_files("exe/*.cpp")

For more WDK driver examples (UMDF/KMDF/WDM), please visitWDK Program Examples

target("test")add_rules("xcode.application")add_files("src/*.m","src/**.storyboard","src/*.xcassets")add_files("src/Info.plist")

target("test")add_rules("xcode.framework")-- or xcode.bundleadd_files("src/*.m")add_files("src/Info.plist")

add_requires("libomp", {optional=true})target("loop")set_kind("binary")add_files("src/*.cpp")add_rules("c++.openmp")add_packages("libomp")

target("test")set_kind("binary")add_files("src/main.zig")

Require the Clang version packaged with LLM-10 to compile a project.

add_requires("llvm 10.x", {alias="llvm-10"})target("test")set_kind("binary")add_files("src/*.c")set_toolchains("llvm@llvm-10")

We can also pull a specified cross-compilation toolchain in to compile the project.

add_requires("muslcc")target("test")set_kind("binary")add_files("src/*.c")set_toolchains("@muslcc")

We can also use the specifiedmuslcc cross-compilation toolchain to compile and integrate all dependent packages.

add_requires("muslcc")add_requires("zlib","libogg", {system=false})set_toolchains("@muslcc")target("test")set_kind("binary")add_files("src/*.c")add_packages("zlib","libogg")

$ xmake project -k vsxmake -m"debug,release"# New vsproj generator (Recommended)$ xmake project -k vs -m"debug,release"$ xmake project -k cmake$ xmake project -k ninja$ xmake project -k compile_commands

$ xmake l ./test.lua$ xmake l -c"print('hello xmake!')"$ xmake l lib.detect.find_tool gcc$ xmake l> print("hello xmake!")> {1, 2, 3}< {    1,    2,    3  }

To see a list of bultin plugs, please visitBuiltin plugins.

Please download and install other plugins from the plugins repositoryxmake-plugins.

• xmake-vscode

• xmake-sublime

• xmake-idea

• xmake.nvim (third-party, thanks@Mythos_404)

• xmake.vim (third-party, thanks@luzhlon)
• xmake-visualstudio (third-party, thanks@HelloWorld886)
• xmake-qtcreator (third-party, thanks@Arthapz)

We can use thexmake-gradle plugin to compile JNI libraries via gradle.

plugins {  id 'org.tboox.gradle-xmake-plugin' version '1.1.5'}android {    externalNativeBuild {        xmake {            path "jni/xmake.lua"        }    }}

ThexmakeBuild task will be injected into theassemble task automatically if thegradle-xmake-plugin has been applied.

$./gradlew app:assembleDebug>Task :nativelib:xmakeConfigureForArm64>Task :nativelib:xmakeBuildForArm64>> xmake build[ 50%]: cache compiling.debug nativelib.cc[ 75%]: linking.debug libnativelib.so[100%]: build ok!>> install artifacts to /Users/ruki/projects/personal/xmake-gradle/nativelib/libs/arm64-v8a>Task :nativelib:xmakeConfigureForArmv7>Task :nativelib:xmakeBuildForArmv7>> xmake build[ 50%]: cache compiling.debug nativelib.cc[ 75%]: linking.debug libnativelib.so[100%]: build ok!>> install artifacts to /Users/ruki/projects/personal/xmake-gradle/nativelib/libs/armeabi-v7a>Task :nativelib:preBuild>Task :nativelib:assemble>Task :app:assembleDebug

Thegithub-action-setup-xmake plugin for GitHub Actions can allow you to use Xmake with minimal efforts if you use GitHub Actions for your CI pipeline.

uses:xmake-io/github-action-setup-xmake@v1with:xmake-version:latest

The list of people and projects who are using Xmake is availablehere.

If you are using Xmake, you are welcome to submit your information to the above list through a PR, so that other users and the developers can gauge interest. Ihis also let users to use xmake more confidently and give us motivation to continue to maintain it.

This will help the Xmake project and it's community grow stronger and expand!

• Email：waruqi@gmail.com
• Homepage：xmake.io
• Community
  • Chat on Reddit
  • Chat on Telegram
  • Chat on Discord
  • Chat on QQ Group: 343118190, 662147501
• Source Code：GitHub,Gitee
• WeChat Public: tboox-os

This project exists thanks to all the people who havecontributed:

• TitanSnow: Provide the xmakelogo and install scripts
• uael: Provide the semantic versioning librarysv
• OpportunityLiu: Improve cuda, tests and ci
• xq144: Improvexrepo env shell, and contribute a lot of packages to thexmake-repo repository.
• enderger: Helped smooth out the edges on the English translation of the README