This is a mirror page, please see the original page:

https://xmake.io/#/guide/quickstart

Usage Video

asciicast

Create Project

$ xmake create -l c -P ./hello

And xmake will generate some files for c language project:

hello
├── src
│   └── main.c
└── xmake.lua

It is a simple console program only for printing hello xmake!

The content of xmake.lua is very simple:

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

Supported Languages


If you want to known more options, please run: xmake create --help

Build Project

$ cd hello
$ xmake

Run Program

$ xmake run hello

Debug Program

To debug the hello, you need change to the debug mode and build it.

$ xmake config -m debug
$ xmake

Then run the following command to debug target program.

$ xmake run -d hello

It will start the debugger (.e.g lldb, gdb, windbg, vsjitdebugger, ollydbg ..) to load our program.

[lldb]$target create "build/hello"
Current executable set to 'build/hello' (x86_64).
[lldb]$b main
Breakpoint 1: where = hello`main, address = 0x0000000100000f50
[lldb]$r
Process 7509 launched: '/private/tmp/hello/build/hello' (x86_64)
Process 7509 stopped
* thread #1: tid = 0x435a2, 0x0000000100000f50 hello`main, queue = 'com.apple.main-thread', stop reason = breakpoint 1.1
    frame #0: 0x0000000100000f50 hello`main
hello`main:
->  0x100000f50 <+0>:  pushq  %rbp
    0x100000f51 <+1>:  movq   %rsp, %rbp
    0x100000f54 <+4>:  leaq   0x2b(%rip), %rdi          ; "hello world!"
    0x100000f5b <+11>: callq  0x100000f64               ; symbol stub for: puts
[lldb]$

To study more debug command, please click the url GDB to LLDB command map

If you want to use the specify debugger, try

$ xmake f --debugger=gdb
$ xmake run -d hello

!> You can also use short command option, for example: xmake r or xmake run