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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
|
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>xmake</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#157878">
<meta name="description" content="一个基于Lua的轻量级自动构建工具">
<meta name="keywords" content="make,makefile,构建工具,编译工具,lua,跨平台,跨平台开发,linux,交叉编译" />
<link rel="stylesheet" href="/assets/css/normalize.css">
<link rel='stylesheet' href="/assets/css/opensans.css" type='text/css'>
<link rel="stylesheet" href="/assets/css/cayman.css">
<!-- baidu stats -->
<script>
var _hmt = _hmt || [];
(function() {
var hm = document.createElement("script");
hm.src = "//hm.baidu.com/hm.js?eb3c91c672a001d78a113bfb8e42017a";
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(hm, s);
})();
</script>
</head>
<body>
<section class="page-header">
<h1 class="project-name">xmake</h1>
<h2 class="project-tagline">一个基于Lua的轻量级自动构建工具</h2>
<a href="/#/zh/" class="btn">开始使用</a>
<br><br>
<iframe src="https://ghbtns.com/github-btn.html?user=tboox&repo=xmake&type=star&count=true" frameborder="0" scrolling="0" width="110px" height="20px"></iframe>
<span class="donate" style="width: 86px">
<img src="/assets/img/patreon.png">
<a href="/cn/pages/donation.html#donate">支持我们</a>
</span>
<br><br>
<ul id="translations">
<li><a href="/cn/" class="nav-link">中文</a></li>
<li class="delimiter">|</li>
<li><a href="/" class="nav-link">English</a></li>
</ul>
</section>
<section class="main-content">
<h2 id="section">安装</h2>
<h4 id="curl">使用curl</h4>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>bash <<span class="o">(</span>curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh<span class="o">)</span>
</code></pre>
</div>
<h4 id="wget">使用wget</h4>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>bash <<span class="o">(</span>wget https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh -O -<span class="o">)</span>
</code></pre>
</div>
<h4 id="powershell">使用powershell</h4>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>Invoke-Expression <span class="o">(</span>Invoke-Webrequest <span class="s1">'https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.ps1'</span> -UseBasicParsing<span class="o">)</span>.Content
</code></pre>
</div>
<h2 id="section-1">简单的工程描述</h2>
<p><img src="/assets/img/index/showcode1.png" width="40%" /></p>
<h2 id="section-2">包依赖描述</h2>
<p><img src="/assets/img/index/add_require.png" width="70%" /></p>
<p>官方的xmake包管理仓库: <a href="https://github.com/xmake-io/xmake-repo">xmake-repo</a></p>
<h2 id="section-3">构建工程</h2>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>xmake
</code></pre>
</div>
<h2 id="section-4">运行目标</h2>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>xmake run console
</code></pre>
</div>
<h2 id="section-5">调试程序</h2>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>xmake run -d console
</code></pre>
</div>
<h2 id="section-6">配置平台</h2>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>xmake f -p <span class="o">[</span>windows|linux|macosx|android|iphoneos ..] -a <span class="o">[</span>x86|arm64 ..] -m <span class="o">[</span>debug|release]
<span class="gp">$ </span>xmake
</code></pre>
</div>
<h2 id="section-7">图形化菜单配置</h2>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>xmake f --menu
</code></pre>
</div>
<p><img src="/assets/img/index/menuconf.png" width="80%" /></p>
<h2 id="section-8">包依赖管理</h2>
<p><img src="/assets/img/index/package_manage.png" width="80%" /></p>
<h2 id="section-9">支持平台</h2>
<ul>
<li>Windows (x86, x64)</li>
<li>Macosx (i386, x86_64)</li>
<li>Linux (i386, x86_64, cross-toolchains …)</li>
<li>Android (armv5te, armv6, armv7-a, armv8-a, arm64-v8a)</li>
<li>iPhoneOS (armv7, armv7s, arm64, i386, x86_64)</li>
<li>WatchOS (armv7k, i386)</li>
<li>Mingw (i386, x86_64)</li>
</ul>
<h2 id="section-10">支持语言</h2>
<ul>
<li>C/C++</li>
<li>Objc/Objc++</li>
<li>Swift</li>
<li>Assembly</li>
<li>Golang</li>
<li>Rust</li>
<li>Dlang</li>
<li>Cuda</li>
</ul>
<h2 id="section-11">工程类型</h2>
<ul>
<li>静态库程序</li>
<li>动态库类型</li>
<li>控制台程序</li>
<li>Cuda程序</li>
<li>Qt应用程序</li>
<li>WDK驱动程序</li>
<li>WinSDK应用程序</li>
</ul>
<h2 id="section-12">内置插件</h2>
<h4 id="section-13">宏记录脚本和回放插件</h4>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>xmake m -b <span class="c"># 开始记录</span>
<span class="gp">$ </span>xmake f -p iphoneos -m debug
<span class="gp">$ </span>xmake
<span class="gp">$ </span>xmake f -p android --ndk<span class="o">=</span>~/files/android-ndk-r16b
<span class="gp">$ </span>xmake
<span class="gp">$ </span>xmake m -e <span class="c"># 结束记录</span>
<span class="gp">$ </span>xmake m . <span class="c"># 回放命令</span>
</code></pre>
</div>
<h4 id="lua">加载自定义lua脚本插件</h4>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>xmake l ./test.lua
<span class="gp">$ </span>xmake l -c <span class="s2">"print('hello xmake!')"</span>
<span class="gp">$ </span>xmake l lib.detect.find_tool gcc
</code></pre>
</div>
<h4 id="idemakefile-vs2002---vs2017-">生成IDE工程文件插件（makefile, vs2002 - vs2017, …）</h4>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>xmake project -k vs2017 -m <span class="s2">"debug,release"</span>
</code></pre>
</div>
<h4 id="doxygen">生成doxygen文档插件</h4>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>xmake doxygen <span class="o">[</span>srcdir]
</code></pre>
</div>
<h2 id="section-14">更多插件</h2>
<p>请到插件仓库进行下载安装: <a href="https://github.com/xmake-io/xmake-plugins">xmake-plugins</a>.</p>
<h2 id="ide">IDE和编辑器插件</h2>
<ul>
<li><a href="https://github.com/xmake-io/xmake-vscode">xmake-vscode</a></li>
</ul>
<p><img src="https://raw.githubusercontent.com/tboox/xmake-vscode/master/res/problem.gif" width="60%" /></p>
<ul>
<li><a href="https://github.com/xmake-io/xmake-sublime">xmake-sublime</a></li>
</ul>
<p><img src="https://raw.githubusercontent.com/tboox/xmake-sublime/master/res/problem.gif" width="60%" /></p>
<ul>
<li><a href="https://github.com/xmake-io/xmake-idea">xmake-idea</a></li>
</ul>
<p><img src="https://raw.githubusercontent.com/tboox/xmake-idea/master/res/problem.gif" width="60%" /></p>
<ul>
<li><a href="https://github.com/luzhlon/xmake.vim">xmake.vim</a> (third-party, thanks <a href="https://github.com/luzhlon">@luzhlon</a>)</li>
</ul>
<h2 id="section-15">更多例子</h2>
<p>Debug和Release模式：</p>
<div class="language-lua highlighter-rouge"><pre class="highlight"><code><span class="n">add_rules</span><span class="p">(</span><span class="s2">"mode.debug"</span><span class="p">,</span> <span class="s2">"mode.release"</span><span class="p">)</span>
<span class="n">target</span><span class="p">(</span><span class="s2">"console"</span><span class="p">)</span>
<span class="n">set_kind</span><span class="p">(</span><span class="s2">"binary"</span><span class="p">)</span>
<span class="n">add_files</span><span class="p">(</span><span class="s2">"src/*.c"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">is_mode</span><span class="p">(</span><span class="s2">"debug"</span><span class="p">)</span> <span class="k">then</span>
<span class="n">add_defines</span><span class="p">(</span><span class="s2">"DEBUG"</span><span class="p">)</span>
<span class="k">end</span>
</code></pre>
</div>
<p>下载和使用远程依赖包：</p>
<div class="language-lua highlighter-rouge"><pre class="highlight"><code><span class="n">add_requires</span><span class="p">(</span><span class="s2">"libuv master"</span><span class="p">,</span> <span class="s2">"ffmpeg"</span><span class="p">,</span> <span class="s2">"zlib 1.20.*"</span><span class="p">)</span>
<span class="n">add_requires</span><span class="p">(</span><span class="s2">"tbox >1.6.1"</span><span class="p">,</span> <span class="p">{</span><span class="n">optional</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span> <span class="n">debug</span> <span class="o">=</span> <span class="kc">true</span><span class="p">})</span>
<span class="n">target</span><span class="p">(</span><span class="s2">"test"</span><span class="p">)</span>
<span class="n">set_kind</span><span class="p">(</span><span class="s2">"shared"</span><span class="p">)</span>
<span class="n">add_files</span><span class="p">(</span><span class="s2">"src/*.c"</span><span class="p">)</span>
<span class="n">add_packages</span><span class="p">(</span><span class="s2">"libuv"</span><span class="p">,</span> <span class="s2">"ffmpeg"</span><span class="p">,</span> <span class="s2">"tbox"</span><span class="p">,</span> <span class="s2">"zlib"</span><span class="p">)</span>
</code></pre>
</div>
<p>查找和使用本地已安装的包：</p>
<div class="language-lua highlighter-rouge"><pre class="highlight"><code><span class="n">target</span><span class="p">(</span><span class="s2">"test"</span><span class="p">)</span>
<span class="n">set_kind</span><span class="p">(</span><span class="s2">"shared"</span><span class="p">)</span>
<span class="n">add_files</span><span class="p">(</span><span class="s2">"src/*.c"</span><span class="p">)</span>
<span class="n">on_load</span><span class="p">(</span><span class="k">function</span> <span class="p">(</span><span class="n">target</span><span class="p">)</span>
<span class="n">import</span><span class="p">(</span><span class="s2">"lib.detect.find_package"</span><span class="p">)</span>
<span class="n">target</span><span class="p">:</span><span class="n">add</span><span class="p">(</span><span class="n">find_package</span><span class="p">(</span><span class="s2">"zlib"</span><span class="p">))</span>
<span class="n">target</span><span class="p">:</span><span class="n">add</span><span class="p">(</span><span class="n">find_package</span><span class="p">(</span><span class="s2">"openssl"</span><span class="p">))</span>
<span class="k">end</span><span class="p">)</span>
</code></pre>
</div>
<h2 id="section-16">项目例子</h2>
<p>一些使用xmake的项目：</p>
<ul>
<li><a href="https://github.com/tboox/tbox">tbox</a></li>
<li><a href="https://github.com/tboox/gbox">gbox</a></li>
<li><a href="https://github.com/tboox/vm86">vm86</a></li>
<li><a href="https://github.com/tboox/awesome-xmake">更多</a></li>
</ul>
<h2 id="section-17">演示视频</h2>
<p><a href="https://asciinema.org/a/133693">
<img src="https://asciinema.org/a/133693.png" width="60%" />
</a></p>
<h2 id="section-18">联系方式</h2>
<ul>
<li>邮箱：<a href="mailto:waruqi@gmail.com">waruqi@gmail.com</a></li>
<li>主页：<a href="https://tboox.org/cn">tboox.org</a></li>
<li>社区：<a href="https://www.reddit.com/r/tboox/">Reddit论坛</a></li>
<li>聊天：<a href="https://t.me/tbooxorg">Telegram群组</a>, <a href="https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">Gitter聊天室</a></li>
<li>源码：<a href="https://github.com/xmake-io/xmake">Github</a>, <a href="https://gitee.com/tboox/xmake">Gitee</a></li>
<li>QQ群：343118190</li>
<li>微信公众号：tboox-os</li>
</ul>
<footer class="site-footer">
<span class="site-footer-owner">Copyright (c) 2015-2018 <a href="https://tboox.org">tboox.org</a>.</span>
<span class="site-footer-power">
<span>
<!--Site powered by <a href="https://jekyllrb.com/">Jekyll</a> & <a href="https://pages.coding.me">Coding Pages</a>.-->
Site powered by <a href="https://jekyllrb.com/">Jekyll</a> & <a href="https://pages.github.com/">Github Pages</a>.
</span>
<span>
Theme designed by <a href="https://github.com/pietromenna/jekyll-cayman-theme">cayman</a>.
</span>
</span>
</footer>
</section>
</body>
</html>
|
