68

GitHub - tboox/xmake: A cross-platform build utility based on Lua

 6 years ago
source link: https://github.com/tboox/xmake
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

README.md

687474703a2f2f74626f6f782e6f72672f7374617469632f696d672f786d616b652f6c6f676f323536632e706e67

xmake

A cross-platform build utility based on Lua

Introduction (中文)

xmake is a cross-platform 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://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh)

via wget

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

via powershell

Invoke-Expression (Invoke-Webrequest 'https://raw.githubusercontent.com/tboox/xmake/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

Configure platform

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

Menu configuration

$ xmake f --menu

687474703a2f2f786d616b652e696f2f6173736574732f696d672f696e6465782f6d656e75636f6e662e676966

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

Builtin Plugins

Macros script plugin

$ xmake m -b                        # start to record
$ xmake f -p iphoneos -m debug
$ xmake
$ xmake m -e                        # stop to record
$ xmake m .                         # playback commands

Run the custom lua script plugin

$ xmake l ./test.lua
$ xmake l -c "print('hello xmake!')"
$ xmake l lib.detect.find_tool gcc

Generate IDE project file plugin(makefile, vs2002 - vs2017 .. )

$ xmake project -k vs2017 -m "debug,release"

More Plugins

Please download and install from the plugins repository xmake-plugins.

IDE/Editor Integration

problem.gif

problem.gif

problem.gif

Examples

68747470733a2f2f61736369696e656d612e6f72672f612f3133333639332e706e67

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

Thanks

This project exists thanks to all the people who have contributed: 68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f786d616b652f636f6e7472696275746f72732e7376673f77696474683d38393026627574746f6e3d66616c7365

  • TitanSnow: provide the xmake logo and install scripts
  • uael: provide the semantic versioning library sv

Backers

Thank you to all our backers! ? [Become a backer]

68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f786d616b652f6261636b6572732e7376673f77696474683d383930

Sponsors

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

68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f786d616b652f73706f6e736f722f302f6176617461722e737667 68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f786d616b652f73706f6e736f722f312f6176617461722e737667 68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f786d616b652f73706f6e736f722f322f6176617461722e737667 68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f786d616b652f73706f6e736f722f332f6176617461722e737667 68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f786d616b652f73706f6e736f722f342f6176617461722e737667 68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f786d616b652f73706f6e736f722f352f6176617461722e737667 68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f786d616b652f73706f6e736f722f362f6176617461722e737667 68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f786d616b652f73706f6e736f722f372f6176617461722e737667 68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f786d616b652f73706f6e736f722f382f6176617461722e737667 68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f786d616b652f73706f6e736f722f392f6176617461722e737667


About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK