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.
HomePage:
http://xmake.io
Github:
https://github.com/tboox/xmake
Simple description
1
2
3
|
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 |
More Plugins
Please download and install from the plugins repository xmake-plugins.
Examples
usage_demo
Create a c++ console project:
1
2
|
xmake create -l c++ -t 1 console
or xmake create --language=c++ --template=1 console
|
Project xmakefile: xmake.lua
1
2
3
|
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.
1
2
3
4
5
6
7
8
9
|
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：
1
2
3
|
xmake
or xmake -r
or xmake --rebuild
|
Run target：
1
2
|
xmake r console
or xmake run console
|
Debug target：
1
2
|
xmake r -d console
or xmake run -d console
|
Package all：
1
2
3
4
5
|
xmake p
or xmake package
or xmake package console
or xmake package -o /tmp
or xmake package --output=/tmp
|
Package all archs using macro:
1
2
3
4
|
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：
1
2
3
4
5
|
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:
1
2
3
4
5
|
xmake -h
or xmake --help
or xmake config --help
or xmake package --help
or xmake macro --help
|
...
The simple xmake.lua file:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
-- 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")
|
