xmake開發(fā)文檔

xmake

一個基于Lua的輕量級跨平臺自動構(gòu)建工具

簡介

XMake是一個基于Lua的輕量級跨平臺自動構(gòu)建工具，支持在各種主流平臺上構(gòu)建項目

xmake的目標(biāo)是開發(fā)者更加關(guān)注于項目本身開發(fā)，簡化項目的描述和構(gòu)建，并且提供平臺無關(guān)性，使得一次編寫，隨處構(gòu)建

它跟cmake、automake、premake有點類似，但是機制不同，它默認(rèn)不會去生成IDE相關(guān)的工程文件，采用直接編譯，并且更加的方便易用 采用lua的工程描述語法更簡潔直觀，支持在大部分常用平臺上進(jìn)行構(gòu)建，以及交叉編譯

并且xmake提供了創(chuàng)建、配置、編譯、打包、安裝、卸載、運行等一些actions，使得開發(fā)和構(gòu)建更加的方便和流程化。

不僅如此，它還提供了許多更加高級的特性，例如插件擴展、腳本宏記錄、批量打包、自動文檔生成等等。。

如果你想要了解更多，請參考：

• 在線文檔
• 項目主頁
• Github
• Gitee

安裝

使用curl

bash <(curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh)

使用wget

bash <(wget https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh -O -)

使用powershell

Invoke-Expression (Invoke-Webrequest 'https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.ps1' -UseBasicParsing).Content

簡單的工程描述

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

構(gòu)建工程

$ xmake

運行目標(biāo)

$ xmake run console

調(diào)試程序

$ xmake run -d console

支持特性

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

支持平臺

• 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)

支持語言

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

內(nèi)置插件

• 宏記錄腳本和回放插件
• 加載自定義lua腳本插件
• 生成IDE工程文件插件（makefile, vs2002 - vs2017, ...）
• 生成doxygen文檔插件

更多插件

請到插件倉庫進(jìn)行下載安裝: xmake-plugins.

簡單例子

創(chuàng)建一個c++ console項目：

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

工程描述文件：xmake.lua

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

配置工程：

這個是可選的步驟，如果只想編譯當(dāng)前主機平臺的項目，是可以不用配置的，默認(rèn)編譯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

編譯工程：

   xmake
or xmake -r
or xmake --rebuild

運行目標(biāo)：

   xmake r console
or xmake run console

調(diào)試目標(biāo)：

   xmake r -d console
or xmake run -d console

打包所有：

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

通過宏腳本打包所有架構(gòu):

   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

安裝目標(biāo)：

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

詳細(xì)使用方式和參數(shù)說明，請參考文檔 或者運行：

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

一些使用xmake的項目：

• tbox
• gbox
• libsvx
• 更多項目

簡單例子

-- 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") 

聯(lián)系方式

• 郵箱：waruqi@gmail.com
• 主頁：tboox.org
• 社區(qū)：TBOOX開源社區(qū)
• QQ群：343118190
• 微信公眾號：tboox-os

感謝

• TitanSnow: 提供xmake logo 和安裝腳本
• uael: 提供語義版本跨平臺c庫 sv