Xmake

<div align="center"> <a href="https://xmake.io"> <img width="160" height="160" src="https://xmake.io/assets/img/logo.png"> </a> <h1>xmake</h1> <div> <a href="https://github.com/xmake-io/xmake/actions?query=workflow%3AWindows"> <img src="https://img.shields.io/github/actions/workflow/status/xmake-io/xmake/windows.yml?branch=master&style=flat-square&logo=windows" alt="github-ci" /> </a> <a href="https://github.com/xmake-io/xmake/actions?query=workflow%3ALinux"> <img src="https://img.shields.io/github/actions/workflow/status/xmake-io/xmake/linux.yml?branch=master&style=flat-square&logo=linux" alt="github-ci" /> </a> <a href="https://github.com/xmake-io/xmake/actions?query=workflow%3AmacOS"> <img src="https://img.shields.io/github/actions/workflow/status/xmake-io/xmake/macos.yml?branch=master&style=flat-square&logo=apple" alt="github-ci" /> </a> <a href="https://github.com/xmake-io/xmake/releases"> <img src="https://img.shields.io/github/release/xmake-io/xmake.svg?style=flat-square" alt="Github All Releases" /> </a> </div> <div> <a href="https://github.com/xmake-io/xmake/blob/master/LICENSE.md"> <img src="https://img.shields.io/github/license/xmake-io/xmake.svg?colorB=f48041&style=flat-square" alt="license" /> </a> <a href="https://www.reddit.com/r/xmake/"> <img src="https://img.shields.io/badge/chat-on%20reddit-ff3f34.svg?style=flat-square" alt="Reddit" /> </a> <a href="https://t.me/tbooxorg"> <img src="https://img.shields.io/badge/chat-on%20telegram-blue.svg?style=flat-square" alt="Telegram" /> </a> <a href="https://jq.qq.com/?_wv=1027&k=5hpwWFv"> <img src="https://img.shields.io/badge/chat-on%20QQ-ff69b4.svg?style=flat-square" alt="QQ" /> </a> <a href="https://discord.gg/xmake"> <img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg?style=flat-square" alt="Discord" /> </a> <a href="https://xmake.io/about/sponsor.html"> <img src="https://img.shields.io/badge/donate-us-orange.svg?style=flat-square" alt="Donate" /> </a> </div>

<b>A cross-platform build utility based on Lua</b><br/> <i>Modern C/C++ build tool: Simple, Fast, Powerful dependency package integration</i><br/>

</div>

Support this project

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

Introduction (中文)

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 the xmake.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 a built-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 the Documentation, GitHub or Gitee. You are also welcome to join our community.

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

Installation

With cURL

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

With Wget

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

With PowerShell

irm https://xmake.io/psget.text | iex

Other installation methods

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

Simple Project Description

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

Creates a new target console of kind binary, and adds all the files ending in .c in the src directory.

Package dependencies

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

<p align="center"> <img src="https://github.com/xmake-io/xmake-docs/raw/master/assets/img/index/package.gif" width="650px" /> </p>

Command line interface reference

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

Build a project

$ xmake

Run target

$ xmake run console

Debug target

$ xmake run -d console

Run test

$ xmake test

Configure platform

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

Menu configuration

$ xmake f --menu

<p align="center"> <img src="https://xmake.io/assets/img/index/menuconf.png" width="650px"/> </p>

Supported platforms

• Windows (x86, x64, arm, arm64, arm64ec)
• macOS (i386, x86_64, arm64)
• Linux (i386, x86_64, arm, arm64, riscv, mips, 390x, sh4 ...)
• FreeBSD (i386, x86_64)
• NetBSD (i386, x86_64)
• OpenBSD (i386, x86_64)
• DragonflyBSD (i386, x86_64)
• Solaris (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)
• AppleXROS (arm64, x86_64)
• MSYS (i386, x86_64)
• MinGW (i386, x86_64, arm, arm64)
• Cygwin (i386, x86_64)
• Wasm (wasm32, wasm64)
• Haiku (i386, x86_64)
• Harmony (x86_64, armeabi-v7a, arm64-v8a)
• Cross (cross-toolchains ..)

Supported toolchains

$ xmake show -l toolchains
xcode         Xcode IDE
msvc          Microsoft Visual C/C++ Compiler
clang-cl      LLVM Clang C/C++ Compiler compatible with msvc
yasm          The Yasm Modular Assembler
clang         A C language family frontend for LLVM
go            Go Programming Language Compiler
dlang         D Programming Language Compiler (Auto)
dmd           D Programming Language Compiler
ldc           The LLVM-based D Compiler
gdc           The GNU D Compiler (GDC)
gfortran      GNU Fortran Programming Language Compiler
flang         LLVM Fortran Compiler
zig           Zig Programming Language Compiler
zigcc         Use zig cc/c++ as C/C++ Compiler
sdcc          Small Device C Compiler
cuda          CUDA Toolkit (nvcc, nvc, nvc++, nvfortran)
ndk           Android NDK
rust          Rust Programming Language Compiler
swift         Swift Programming Language Compiler
llvm          A collection of modular and reusable compiler and toolchain technologies
cross         Common cross compilation toolchain
nasm          NASM Assembler
gcc           GNU Compiler Collection
mingw         Minimalist GNU for Windows
gnu-rm        GNU Arm Embedded Toolchain
envs          Environment variables toolchain
fasm          Flat Assembler
tinycc        Tiny C Compiler
emcc          A toolchain for compiling to asm.js and WebAssembly
icc           Intel C/C++ Compiler
ifort         Intel Fortran Compiler
ifx           Intel LLVM Fortran Compiler
muslcc        The musl-based cross-compilation toolchain
fpc           Free Pascal Programming Language Compiler
wasi          WASI-enabled WebAssembly C/C++ toolchain
nim           Nim Programming Language Compiler
dotnet        .NET SDK Toolchain
circle        A new C++20 compiler
armcc         ARM Compiler Version 5 of Keil MDK
armclang      ARM Compiler Version 6 of Keil MDK
c51           Keil development tools for the 8051 Microcontroller Architecture
icx           Intel LLVM C/C++ Compiler
dpcpp         Intel LLVM C++ Compiler for data parallel programming model based on Khronos SYCL
masm32        The MASM32 SDK
iverilog      Icarus Verilog
verilator     Verilator open-source SystemVerilog simulator and lint system
cosmocc       build-once run-anywhere
hdk           Harmony SDK
ti-c2000      TI-CGT C2000 compiler
ti-c6000      TI-CGT C6000 compiler
iararm        IAR ARM C/C++ Compiler
kotlin-native Kotlin Native Programming Language Compiler
filc          A memory safe implementation of the C and C++ programming languages (https://fil-c.org/)

Supported languages

• C and C++
• Objective-C and Objective-C++
• Swift
• Assembly
• Golang
• Rust
• Dlang
• Fortran
• Cuda
• Zig
• Vala
• Pascal
• Nim
• Verilog
• FASM
• NASM
• YASM
• MASM32
• Cppfront
• Kotlin
• C#

Features

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

Supported Project Types

Xmake supports the below types of projects:

• Static libraries
• Shared libraries
• Console/CLI applications
• CUDA programs
• Qt applications
• WDK drivers (umdf/kmdf/wdm)
• WinSDK