Skip to content

Latest commit

 

History

History
258 lines (185 loc) · 5.42 KB

README.md

File metadata and controls

258 lines (185 loc) · 5.42 KB
Raw

A make-like build utility based on Lua

Build Status Build status codecov Join the chat at https://gitter.im/tboox/tboox donate

logo

Introduction (中文)

xmake is a make-like build utility based on lua.

The project focuses on making development and building easier and provides many features (.e.g package, install, plugin, macro, action, option, task ...), so that any developer can quickly pick it up and enjoy the productivity boost when developing and building project.

If you want to known more, please refer to:

Installation

via curl
$ bash <(curl -fsSL https://github.com/tboox/xmake/raw/master/scripts/get.sh)
via wget
$ bash <(wget https://github.com/tboox/xmake/raw/master/scripts/get.sh -O -)
via powershell
$ Invoke-Expression (Invoke-Webrequest 'https://github.com/tboox/xmake/raw/master/scripts/get.ps1' -UseBasicParsing).Content

Simple description

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

Build project

$ xmake

Run target

$ xmake run console

Debug target

$ xmake run -d console

Support features

  • Tasks
  • Macros
  • Actions
  • Options
  • Plugins
  • Templates

Support platforms

  • Windows (x86, x64, amd64, x86_amd64)
  • Macosx (i386, x86_64)
  • Linux (i386, x86_64, cross-toolchains ...)
  • Android (armv5te, armv6, armv7-a, armv8-a, arm64-v8a)
  • iPhoneOS (armv7, armv7s, arm64, i386, x86_64)
  • WatchOS (armv7k, i386)
  • Mingw (i386, x86_64)

Support Languages

  • C/C++
  • Objc/Objc++
  • Swift
  • Assembly
  • Golang
  • Rust
  • Dlang

Builtin Plugins

  • Macros script plugin
  • Run the custom lua script plugin
  • Generate IDE project file plugin（makefile, vs2002 - vs2017 .. ）
  • Generate doxygen document plugin
  • Convert .app to .ipa plugin

Examples

usage_demo

Create a c++ console project:

    xmake create -l c++ -t 1 console
 or xmake create --language=c++ --template=1 console

Project xmakefile: xmake.lua

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

Configure project:

This is optional, if you compile the targets only for linux, macosx and windows and the default compilation mode is release.

   xmake f -p iphoneos -m debug
or xmake f --plat=macosx --arch=x86_64
or xmake f -p windows
or xmake config --plat=iphoneos --mode=debug
or xmake config --plat=android --arch=armv7-a --ndk=xxxxx
or xmake config -p linux -a i386
or xmake config -p mingw --cross=i386-mingw32- --toolchains=/xxx/bin
or xmake config -p mingw --sdk=/mingwsdk
or xmake config --help

Compile project：

   xmake
or xmake -r
or xmake --rebuild

Run target：

   xmake r console
or xmake run console

Debug target：

   xmake r -d console
or xmake run -d console

Package all：

   xmake p
or xmake package
or xmake package console
or xmake package -o /tmp
or xmake package --output=/tmp

Package all archs using macro:

   xmake m package 
or xmake m package -p iphoneos
or xmake m package -p macosx -f "-m debug" -o /tmp/
or xmake m package --help

Install targets：

   xmake i
or xmake install
or xmake install console
or xmake install -o /tmp
or xmake install --output=/tmp

If you need known more detailed usage，please refer to documents or run:

   xmake -h
or xmake --help
or xmake config --help
or xmake package --help
or xmake macro --help
...

The simple xmake.lua file:

-- the debug mode
if is_mode("debug") then
    
    -- enable the debug symbols
    set_symbols("debug")

    -- disable optimization
    set_optimize("none")
end

-- the release mode
if is_mode("release") then

    -- set the symbols visibility: hidden
    set_symbols("hidden")

    -- enable fastest optimization
    set_optimize("fastest")

    -- strip all symbols
    set_strip("all")
end

-- add target
target("test")

    -- set kind
    set_kind("static")

    -- add files
    add_files("src/*.c")

If you want to know more, please refer to:

Documents

Projects

Some projects using xmake:

Contacts