getting_started.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>xmake</title>
  6. <link rel="icon" href="/assets/img/favicon.ico">
  7. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
  8. <meta name="description" content="Description">
  9. <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
  10. <link href="/assets/npm/github-markdown/github-markdown.min.css" rel="stylesheet">
  11. <style>
  12. .markdown-body {
  13. box-sizing: border-box;
  14. min-width: 200px;
  15. max-width: 980px;
  16. margin: 0 auto;
  17. padding: 45px;
  18. }
  19. @media (max-width: 767px) {
  20. .markdown-body {
  21. padding: 15px;
  22. }
  23. }
  24. </style>
  25. </head>
  26. <body>
  27. <article class="markdown-body">
  28. <h4>This is a mirror page, please see the original page: </h4><a href="https://xmake.io/#/getting_started">https://xmake.io/#/getting_started</a>
  29. <div id="wwads-panel" class="wwads-cn wwads-vertical wwads-sticky" data-id="239" style="max-width:180px;bottom:20px;right:20px;width:200px;height:260px;background:#fff;position:fixed"></div>
  30. </br>
  31. <script type="text/javascript" charset="UTF-8" src="https://cdn.wwads.cn/js/makemoney.js" async></script>
  32. <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?serve=CE7I52QU&placement=xmakeio" id="_carbonads_js"></script>
  33. <style>
  34. #carbonads {
  35. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu,
  36. Cantarell, "Helvetica Neue", Helvetica, Arial, sans-serif;
  37. }
  38. #carbonads {
  39. display: flex;
  40. max-width: 330px;
  41. background-color: hsl(0, 0%, 98%);
  42. box-shadow: 0 1px 4px 1px hsla(0, 0%, 0%, .1);
  43. }
  44. #carbonads a {
  45. color: inherit;
  46. text-decoration: none;
  47. }
  48. #carbonads a:hover {
  49. color: inherit;
  50. }
  51. #carbonads span {
  52. position: relative;
  53. display: block;
  54. overflow: hidden;
  55. }
  56. #carbonads .carbon-wrap {
  57. display: flex;
  58. }
  59. .carbon-img {
  60. display: block;
  61. margin: 0;
  62. line-height: 1;
  63. }
  64. .carbon-img img {
  65. display: block;
  66. }
  67. .carbon-text {
  68. font-size: 13px;
  69. padding: 10px;
  70. line-height: 1.5;
  71. text-align: left;
  72. }
  73. .carbon-poweredby {
  74. display: block;
  75. padding: 8px 10px;
  76. background: repeating-linear-gradient(-45deg, transparent, transparent 5px, hsla(0, 0%, 0%, .025) 5px, hsla(0, 0%, 0%, .025) 10px) hsla(203, 11%, 95%, .4);
  77. text-align: center;
  78. text-transform: uppercase;
  79. letter-spacing: .5px;
  80. font-weight: 600;
  81. font-size: 9px;
  82. line-height: 1;
  83. }
  84. </style>
  85. <h2 id="supportingtheproject">Supporting the project</h2>
  86. <p>Support this project by becoming a sponsor. Your logo will show up here with a link to your website. 🙏</p>
  87. <ul>
  88. <li><a href="https://xmake.io/#/about/sponsor">Become a sponsor</a></li>
  89. </ul>
  90. <p><a href="https://opencollective.com/xmake#sponsors" target="_blank"><img src="https://opencollective.com/xmake/sponsors.svg?width=890"></a></p>
  91. <h2 id="introduction">Introduction</h2>
  92. <p>xmake is a lightweight cross-platform build utility based on Lua. It uses xmake.lua to maintain project builds. Compared with makefile/CMakeLists.txt, the configuration syntax is more concise and intuitive. It is very friendly to novices and can quickly get started in a short time. Let users focus more on actual project development.</p>
  93. <p>It can compile the project directly like Make/Ninja, or generate project files like CMake/Meson, and it also has a built-in package management system to help users solve the integrated use of C/C++ dependent libraries.</p>
  94. <pre><code>Xmake = Build backend + Project Generator + Package Manager
  95. </code></pre><p>If you want to know more, please refer to: <a href="https://xmake.io/#/getting_started">Documents</a>, <a href="https://github.com/xmake-io/xmake">Github</a> and <a href="https://gitee.com/tboox/xmake">Gitee</a> and also welcome to join our <a href="https://xmake.io/#/about/contact">community</a>.</p>
  96. <p><img src="https://xmake.io/assets/img/index/xmake-basic-render.gif" alt=""></p>
  97. <h2 id="installation">Installation</h2>
  98. <h4 id="viacurl">via curl</h4>
  99. <pre><code class="lang-bash">curl -fsSL https://xmake.io/shget.text | bash
  100. </code></pre>
  101. <h4 id="viawget">via wget</h4>
  102. <pre><code class="lang-bash">wget https://xmake.io/shget.text -O - | bash
  103. </code></pre>
  104. <h4 id="viapowershell">via powershell</h4>
  105. <pre><code class="lang-powershell">Invoke-Expression (Invoke-Webrequest &#39;https://xmake.io/psget.text&#39; -UseBasicParsing).Content
  106. </code></pre>
  107. <h4 id="otherinstallationways">Other installation ways</h4>
  108. <p>If you don&#39;t want to use script to install xmake, you can also click <a href="https://xmake.io/#/guide/installation">Installation Guide</a> to get other installation ways.</p>
  109. <h2 id="simpledescription">Simple description</h2>
  110. <pre><code class="lang-lua">target("hello")
  111. set_kind("binary")
  112. add_files("src/*.cpp")
  113. </code></pre>
  114. <h2 id="packagedependences">Package dependences</h2>
  115. <pre><code class="lang-lua">add_requires("tbox 1.6.*", "zlib", "libpng ~1.6")
  116. </code></pre>
  117. <p>An official xmake package repository: <a href="https://github.com/xmake-io/xmake-repo">xmake-repo</a></p>
  118. <h2 id="buildproject">Build project</h2>
  119. <pre><code class="lang-bash">$ xmake
  120. </code></pre>
  121. <h2 id="runtarget">Run target</h2>
  122. <pre><code class="lang-bash">$ xmake run console
  123. </code></pre>
  124. <h2 id="debugtarget">Debug target</h2>
  125. <pre><code class="lang-bash">$ xmake run -d console
  126. </code></pre>
  127. <h2 id="configureplatform">Configure platform</h2>
  128. <pre><code class="lang-bash">$ xmake f -p [windows|linux|macosx|android|iphoneos ..] -a [x86|arm64 ..] -m [debug|release]
  129. $ xmake
  130. </code></pre>
  131. <h2 id="menuconfiguration">Menu configuration</h2>
  132. <pre><code class="lang-bash">$ xmake f --menu
  133. </code></pre>
  134. <p><img src="https://xmake.io/assets/img/index/menuconf.png" width="650px" /></p>
  135. <h2 id="buildasfastasninja">Build as fast as ninja</h2>
  136. <p>The test project: <a href="https://github.com/xmake-io/xmake/tree/master/core">xmake-core</a></p>
  137. <h3 id="multitaskparallelcompilation">Multi-task parallel compilation</h3>
  138. <table>
  139. <thead>
  140. <tr>
  141. <th>buildsystem</th>
  142. <th>Termux (8core/-j12)</th>
  143. <th>buildsystem</th>
  144. <th>MacOS (8core/-j12)</th>
  145. </tr>
  146. </thead>
  147. <tbody>
  148. <tr>
  149. <td>xmake</td>
  150. <td>24.890s</td>
  151. <td>xmake</td>
  152. <td>12.264s</td>
  153. </tr>
  154. <tr>
  155. <td>ninja</td>
  156. <td>25.682s</td>
  157. <td>ninja</td>
  158. <td>11.327s</td>
  159. </tr>
  160. <tr>
  161. <td>cmake(gen+make)</td>
  162. <td>5.416s+28.473s</td>
  163. <td>cmake(gen+make)</td>
  164. <td>1.203s+14.030s</td>
  165. </tr>
  166. <tr>
  167. <td>cmake(gen+ninja)</td>
  168. <td>4.458s+24.842s</td>
  169. <td>cmake(gen+ninja)</td>
  170. <td>0.988s+11.644s</td>
  171. </tr>
  172. </tbody>
  173. </table>
  174. <h3 id="singletaskcompilation">Single task compilation</h3>
  175. <table>
  176. <thead>
  177. <tr>
  178. <th>buildsystem</th>
  179. <th>Termux (-j1)</th>
  180. <th>buildsystem</th>
  181. <th>MacOS (-j1)</th>
  182. </tr>
  183. </thead>
  184. <tbody>
  185. <tr>
  186. <td>xmake</td>
  187. <td>1m57.707s</td>
  188. <td>xmake</td>
  189. <td>39.937s</td>
  190. </tr>
  191. <tr>
  192. <td>ninja</td>
  193. <td>1m52.845s</td>
  194. <td>ninja</td>
  195. <td>38.995s</td>
  196. </tr>
  197. <tr>
  198. <td>cmake(gen+make)</td>
  199. <td>5.416s+2m10.539s</td>
  200. <td>cmake(gen+make)</td>
  201. <td>1.203s+41.737s</td>
  202. </tr>
  203. <tr>
  204. <td>cmake(gen+ninja)</td>
  205. <td>4.458s+1m54.868s</td>
  206. <td>cmake(gen+ninja)</td>
  207. <td>0.988s+38.022s</td>
  208. </tr>
  209. </tbody>
  210. </table>
  211. <h2 id="packagemanagement">Package management</h2>
  212. <h3 id="downloadandbuild">Download and build</h3>
  213. <p><img src="https://xmake.io/assets/img/index/package_manage.png" width="650px" /></p>
  214. <h3 id="processingarchitecture">Processing architecture</h3>
  215. <p><img src="https://xmake.io/assets/img/index/package_arch.png" width="650px" /></p>
  216. <h3 id="supportedpackagerepositories">Supported package repositories</h3>
  217. <ul>
  218. <li>Official package repository <a href="https://github.com/xmake-io/xmake-repo">xmake-repo</a> (tbox >1.6.1)</li>
  219. <li>Official package manager <a href="https://github.com/xmake-io/xrepo">Xrepo</a></li>
  220. <li><a href="https://xmake.io/#/package/remote_package?id=using-self-built-private-package-repository">User-built repositories</a></li>
  221. <li>Conan (conan::openssl/1.1.1g)</li>
  222. <li>Conda (conda::libpng 1.3.67)</li>
  223. <li>Vcpkg (vcpkg::ffmpeg)</li>
  224. <li>Homebrew/Linuxbrew (brew::pcre2/libpcre2-8)</li>
  225. <li>Pacman on archlinux/msys2 (pacman::libcurl)</li>
  226. <li>Apt on ubuntu/debian (apt::zlib1g-dev)</li>
  227. <li>Clib (clib::<a href="mailto:clibs/[email protected]">clibs/[email protected]</a>)</li>
  228. <li>Dub (dub::log 0.4.3)</li>
  229. <li>Portage on Gentoo/Linux (portage::libhandy)</li>
  230. <li>Nimble for nimlang (nimble::zip >1.3)</li>
  231. </ul>
  232. <h3 id="packagemanagementfeatures">Package management features</h3>
  233. <ul>
  234. <li>The official repository provides nearly 500+ packages, one-click compilation on all platforms</li>
  235. <li>Full platform package support, support for cross-compiled dependent package integration</li>
  236. <li>Support package virtual environment, <code>xrepo env shell</code></li>
  237. <li>Precompiled package acceleration for windows</li>
  238. <li>Support self-built package repositories, private repository deployment</li>
  239. <li>Third-party package repository support, such as: vcpkg, conan, conda, etc.</li>
  240. <li>Support to pull using remote toolchain automatically</li>
  241. <li>Support to lock package dependency</li>
  242. </ul>
  243. <h2 id="supportedplatforms">Supported platforms</h2>
  244. <ul>
  245. <li>Windows (x86, x64)</li>
  246. <li>macOS (i386, x86_64, arm64)</li>
  247. <li>Linux (i386, x86_64, cross-toolchains ..)</li>
  248. <li>*BSD (i386, x86_64)</li>
  249. <li>Android (x86, x86_64, armeabi, armeabi-v7a, arm64-v8a)</li>
  250. <li>iOS (armv7, armv7s, arm64, i386, x86_64)</li>
  251. <li>WatchOS (armv7k, i386)</li>
  252. <li>AppleTVOS (armv7, arm64, i386, x86_64)</li>
  253. <li>MSYS (i386, x86_64)</li>
  254. <li>MinGW (i386, x86_64, arm, arm64)</li>
  255. <li>Cygwin (i386, x86_64)</li>
  256. <li>Wasm (wasm32)</li>
  257. <li>Cross (cross-toolchains ..)</li>
  258. </ul>
  259. <h2 id="supportedtoolchains">Supported toolchains</h2>
  260. <pre><code class="lang-text">$ xmake show -l toolchains
  261. xcode Xcode IDE
  262. vs VisualStudio IDE
  263. yasm The Yasm Modular Assembler
  264. clang A C language family frontend for LLVM
  265. go Go Programming Language Compiler
  266. dlang D Programming Language Compiler
  267. gfortran GNU Fortran Programming Language Compiler
  268. zig Zig Programming Language Compiler
  269. sdcc Small Device C Compiler
  270. cuda CUDA Toolkit
  271. ndk Android NDK
  272. rust Rust Programming Language Compiler
  273. llvm A collection of modular and reusable compiler and toolchain technologies
  274. cross Common cross compilation toolchain
  275. nasm NASM Assembler
  276. gcc GNU Compiler Collection
  277. mingw Minimalist GNU for Windows
  278. gnu-rm GNU Arm Embedded Toolchain
  279. envs Environment variables toolchain
  280. fasm Flat Assembler
  281. tinycc Tiny C Compiler
  282. emcc A toolchain for compiling to asm.js and WebAssembly
  283. icc Intel C/C++ Compiler
  284. ifort Intel Fortran Compiler
  285. muslcc The musl-based cross-compilation toolchain
  286. fpc Free Pascal Programming Language Compiler
  287. wasi WASI-enabled WebAssembly C/C++ toolchain
  288. nim Nim Programming Language Compiler
  289. circle A new C++20 compiler
  290. armcc ARM Compiler Version 5 of Keil MDK
  291. armclang ARM Compiler Version 6 of Keil MDK
  292. </code></pre>
  293. <h2 id="supportedlanguages">Supported Languages</h2>
  294. <ul>
  295. <li>C</li>
  296. <li>C++</li>
  297. <li>Objective-C and Objective-C++</li>
  298. <li>Swift</li>
  299. <li>Assembly</li>
  300. <li>Golang</li>
  301. <li>Rust</li>
  302. <li>Dlang</li>
  303. <li>Fortran</li>
  304. <li>Cuda</li>
  305. <li>Zig</li>
  306. <li>Vala</li>
  307. <li>Pascal</li>
  308. <li>Nim</li>
  309. </ul>
  310. <h2 id="supportedfeatures">Supported Features</h2>
  311. <ul>
  312. <li>The configuration grammar is simple and easy to use</li>
  313. <li>Quick installation, without any dependencies</li>
  314. <li>One-click compilation for all platforms</li>
  315. <li>Support cross compilation, intelligent analysis of cross tool chain information</li>
  316. <li>Extremely fast, multi-task parallel compilation support</li>
  317. <li>C++20 Module support</li>
  318. <li>Support cross-platform C/C++ dependency package quick integration, built-in package manager</li>
  319. <li>Multi-language mixed compilation support</li>
  320. <li>Rich plug-in support, providing various project generators, such as: vs/makefile/cmakelists/compile_commands to generate plugins</li>
  321. <li>REPL interactive execution support</li>
  322. <li>Incremental compilation support, automatic analysis of header files</li>
  323. <li>Quick switching and customization support of tool chain</li>
  324. <li>A large number of expansion modules support</li>
  325. </ul>
  326. <h2 id="supportedprojects">Supported Projects</h2>
  327. <ul>
  328. <li>Static Library</li>
  329. <li>Shared Library</li>
  330. <li>Console</li>
  331. <li>Cuda Program</li>
  332. <li>Qt Application</li>
  333. <li>WDK Driver (umdf/kmdf/wdm)</li>
  334. <li>WinSDK Application</li>
  335. <li>MFC Application</li>
  336. <li>iOS/MacOS Application (Support .metal)</li>
  337. <li>Framework and Bundle Program (iOS/MacOS)</li>
  338. <li>SWIG Modules (Lua, python, ...)</li>
  339. <li>Luarocks Modules</li>
  340. <li>Protobuf Program</li>
  341. <li>Lex/yacc program</li>
  342. <li>C++20 Modules</li>
  343. </ul>
  344. <h2 id="moreexamples">More Examples</h2>
  345. <h4 id="debugandreleasemodes">Debug and release modes</h4>
  346. <pre><code class="lang-lua">add_rules("mode.debug", "mode.release")
  347. target("console")
  348. set_kind("binary")
  349. add_files("src/*.c")
  350. if is_mode("debug") then
  351. add_defines("DEBUG")
  352. end
  353. </code></pre>
  354. <h4 id="customscripts">Custom scripts</h4>
  355. <pre><code class="lang-lua">target("test")
  356. set_kind("binary")
  357. add_files("src/*.c")
  358. after_build(function (target)
  359. print("hello: %s", target:name())
  360. os.exec("echo %s", target:targetfile())
  361. end)
  362. </code></pre>
  363. <h4 id="automaticintegrationofdependentpackages">Automatic integration of dependent packages</h4>
  364. <p>Download and use packages in <a href="https://github.com/xmake-io/xmake-repo">xmake-repo</a> or third-party repositories:</p>
  365. <pre><code class="lang-lua">add_requires("tbox >1.6.1", "libuv master", "vcpkg::ffmpeg", "brew::pcre2/libpcre2-8")
  366. add_requires("conan::openssl/1.1.1g", {alias = "openssl", optional = true, debug = true})
  367. target("test")
  368. set_kind("binary")
  369. add_files("src/*.c")
  370. add_packages("tbox", "libuv", "vcpkg::ffmpeg", "brew::pcre2/libpcre2-8", "openssl")
  371. </code></pre>
  372. <p>In addition, we can also use the <a href="https://github.com/xmake-io/xrepo">xrepo</a> command to quickly install dependent packages.</p>
  373. <h4 id="qtquickappprogram">Qt QuickApp Program</h4>
  374. <pre><code class="lang-lua">target("test")
  375. add_rules("qt.quickapp")
  376. add_files("src/*.cpp")
  377. add_files("src/qml.qrc")
  378. </code></pre>
  379. <h4 id="cudaprogram">Cuda Program</h4>
  380. <pre><code class="lang-lua">target("test")
  381. set_kind("binary")
  382. add_files("src/*.cu")
  383. add_cugencodes("native")
  384. add_cugencodes("compute_35")
  385. </code></pre>
  386. <h4 id="wdkumdfdriverprogram">WDK/UMDF Driver Program</h4>
  387. <pre><code class="lang-lua">target("echo")
  388. add_rules("wdk.driver", "wdk.env.umdf")
  389. add_files("driver/*.c")
  390. add_files("driver/*.inx")
  391. add_includedirs("exe")
  392. target("app")
  393. add_rules("wdk.binary", "wdk.env.umdf")
  394. add_files("exe/*.cpp")
  395. </code></pre>
  396. <p>More wdk driver program examples (umdf/kmdf/wdm), please see <a href="https://xmake.io/#/guide/project_examples?id=wdk-driver-program">WDK Program Examples</a></p>
  397. <h4 id="iosmacosapplication">iOS/MacOS Application</h4>
  398. <pre><code class="lang-lua">target("test")
  399. add_rules("xcode.application")
  400. add_files("src/*.m", "src/**.storyboard", "src/*.xcassets")
  401. add_files("src/Info.plist")
  402. </code></pre>
  403. <h4 id="frameworkandbundleprogramiosmacos">Framework and Bundle Program (iOS/MacOS)</h4>
  404. <pre><code class="lang-lua">target("test")
  405. add_rules("xcode.framework") -- or xcode.bundle
  406. add_files("src/*.m")
  407. add_files("src/Info.plist")
  408. </code></pre>
  409. <h4 id="openmpprogram">OpenMP Program</h4>
  410. <pre><code class="lang-lua">add_requires("openmp")
  411. target("loop")
  412. set_kind("binary")
  413. add_files("src/*.cpp")
  414. add_packages("openmp")
  415. </code></pre>
  416. <h4 id="zigprogram">Zig Program</h4>
  417. <pre><code class="lang-lua">target("test")
  418. set_kind("binary")
  419. add_files("src/main.zig")
  420. </code></pre>
  421. <h3 id="automaticallyfetchremotetoolchain">Automatically fetch remote toolchain</h3>
  422. <h4 id="fetchthespecialversionofllvm">fetch the special version of llvm</h4>
  423. <p>We use clang in llvm-10 to compile the project.</p>
  424. <pre><code class="lang-lua">add_requires("llvm 10.x", {alias = "llvm-10"})
  425. target("test")
  426. set_kind("binary")
  427. add_files("src/*.c)
  428. set_toolchains("llvm@llvm-10")
  429. </code></pre>
  430. <h4 id="fetchcrosscompilationtoolchain">Fetch cross-compilation toolchain</h4>
  431. <p>We can also pull the specified cross-compilation tool chain to compile the project.</p>
  432. <pre><code class="lang-lua">add_requires("muslcc")
  433. target("test")
  434. set_kind("binary")
  435. add_files("src/*.c)
  436. set_toolchains("@muslcc")
  437. </code></pre>
  438. <h4 id="fetchtoolchainandpackages">Fetch toolchain and packages</h4>
  439. <p>We can also use the specified muslcc cross-compilation toolchain to compile and integrate all dependent packages</p>
  440. <pre><code class="lang-lua">add_requires("muslcc")
  441. add_requires("zlib", "libogg", {system = false})
  442. set_toolchains("@muslcc")
  443. target("test")
  444. set_kind("binary")
  445. add_files("src/*.c")
  446. add_packages("zlib", "libogg")
  447. </code></pre>
  448. <h2 id="plugins">Plugins</h2>
  449. <h4 id="generateideprojectfilepluginmakefilevs2002vs2019">Generate IDE project file plugin(makefile, vs2002 - vs2019 .. )</h4>
  450. <pre><code class="lang-bash">$ xmake project -k vsxmake -m "debug;release" # New vsproj generator (Recommended)
  451. $ xmake project -k vs -m "debug;release"
  452. $ xmake project -k cmake
  453. $ xmake project -k ninja
  454. $ xmake project -k compile_commands
  455. </code></pre>
  456. <h4 id="runthecustomluascriptplugin">Run the custom lua script plugin</h4>
  457. <pre><code class="lang-bash">$ xmake l ./test.lua
  458. $ xmake l -c "print(&#39;hello xmake!&#39;)"
  459. $ xmake l lib.detect.find_tool gcc
  460. $ xmake l
  461. > print("hello xmake!")
  462. > {1, 2, 3}
  463. < {
  464. 1,
  465. 2,
  466. 3
  467. }
  468. </code></pre>
  469. <p>More builtin plugins, please see: <a href="https://xmake.io/#/plugin/builtin_plugins">Builtin plugins</a></p>
  470. <p>Please download and install more other plugins from the plugins repository <a href="https://github.com/xmake-io/xmake-plugins">xmake-plugins</a>.</p>
  471. <h2 id="ideeditorintegration">IDE/Editor Integration</h2>
  472. <ul>
  473. <li><a href="https://github.com/xmake-io/xmake-vscode">xmake-vscode</a></li>
  474. </ul>
  475. <p><img src="https://raw.githubusercontent.com/xmake-io/xmake-vscode/master/res/problem.gif" width="650px" /></p>
  476. <ul>
  477. <li><a href="https://github.com/xmake-io/xmake-sublime">xmake-sublime</a></li>
  478. </ul>
  479. <p><img src="https://raw.githubusercontent.com/xmake-io/xmake-sublime/master/res/problem.gif" width="650px" /></p>
  480. <ul>
  481. <li><a href="https://github.com/xmake-io/xmake-idea">xmake-idea</a></li>
  482. </ul>
  483. <p><img src="https://raw.githubusercontent.com/xmake-io/xmake-idea/master/res/problem.gif" width="650px" /></p>
  484. <ul>
  485. <li><a href="https://github.com/Mythos-404/xmake.nvim">xmake.nvim</a> (third-party, thanks <a href="https://github.com/Mythos-404">@Mythos_404</a>)</li>
  486. </ul>
  487. <p><img src="https://raw.githubusercontent.com/Mythos-404/xmake.nvim/main/assets/XmakePreview.gif" width="650px" /></p>
  488. <ul>
  489. <li><p><a href="https://github.com/luzhlon/xmake.vim">xmake.vim</a> (third-party, thanks <a href="https://github.com/luzhlon">@luzhlon</a>)</p>
  490. </li>
  491. <li><p><a href="https://github.com/HelloWorld886/xmake-visualstudio">xmake-visualstudio</a> (third-party, thanks <a href="https://github.com/HelloWorld886">@HelloWorld886</a>)</p>
  492. </li>
  493. <li><p><a href="https://github.com/Arthapz/xmake-project-manager">xmake-qtcreator</a> (third-party, thanks <a href="https://github.com/Arthapz">@Arthapz</a>)</p>
  494. </li>
  495. </ul>
  496. <h3 id="xmakegradlepluginjni">XMake Gradle Plugin (JNI)</h3>
  497. <p>We can uses <a href="https://github.com/xmake-io/xmake-gradle">xmake-gradle</a> plugin to compile JNI library in gradle.</p>
  498. <pre><code>plugins {
  499. id &#39;org.tboox.gradle-xmake-plugin&#39; version &#39;1.1.4&#39;
  500. }
  501. android {
  502. externalNativeBuild {
  503. xmake {
  504. path "jni/xmake.lua"
  505. }
  506. }
  507. }
  508. </code></pre><p>The <code>xmakeBuild</code> will be injected to <code>assemble</code> task automatically if the gradle-xmake-plugin has been applied.</p>
  509. <pre><code class="lang-console">$ ./gradlew app:assembleDebug
  510. > Task :nativelib:xmakeConfigureForArm64
  511. > Task :nativelib:xmakeBuildForArm64
  512. >> xmake build
  513. [ 50%]: cache compiling.debug nativelib.cc
  514. [ 75%]: linking.debug libnativelib.so
  515. [100%]: build ok!
  516. >> install artifacts to /Users/ruki/projects/personal/xmake-gradle/nativelib/libs/arm64-v8a
  517. > Task :nativelib:xmakeConfigureForArmv7
  518. > Task :nativelib:xmakeBuildForArmv7
  519. >> xmake build
  520. [ 50%]: cache compiling.debug nativelib.cc
  521. [ 75%]: linking.debug libnativelib.so
  522. [100%]: build ok!
  523. >> install artifacts to /Users/ruki/projects/personal/xmake-gradle/nativelib/libs/armeabi-v7a
  524. > Task :nativelib:preBuild
  525. > Task :nativelib:assemble
  526. > Task :app:assembleDebug
  527. </code></pre>
  528. <h2 id="technicalsupport">Technical Support</h2>
  529. <p>We also provide paid technical support to help users quickly solve related problems. For details, please click the image link below:</p>
  530. <p><a href="https://xscode.com/waruqi/xmake"><br><img src="https://tboox.org/assets/img/xmake-xscode.png" width="650px" /><br></a></p>
  531. <p>Or you can also consider sponsoring us to get technical support services, [<a href="https://xmake.io/#/about/sponsor">Become a sponsor</a>]</p>
  532. <h2 id="whoisusingxmake">Who is using Xmake?</h2>
  533. <p>Please click <a href="https://xmake.io/#/about/who_is_using_xmake">User List</a> to view the complete user list.</p>
  534. <p>If you are using xmake, welcome to submit the information to the above list through PR, so that let more users can known how many users are using xmake.</p>
  535. <p>Ihis also let users to use xmake more confidently, and we will also have more motivation to maintain it continuously,<br>so that the xmake project and the community will grow stronger.</p>
  536. <h2 id="contacts">Contacts</h2>
  537. <ul>
  538. <li>Email:<a href="mailto:[email protected]">[email protected]</a></li>
  539. <li>Homepage:<a href="https://xmake.io">xmake.io</a></li>
  540. <li>Community<ul>
  541. <li><a href="https://www.reddit.com/r/xmake/">Chat on reddit</a></li>
  542. <li><a href="https://t.me/tbooxorg">Chat on telegram</a></li>
  543. <li><a href="https://discord.gg/xmake">Chat on discord</a></li>
  544. <li>Chat on QQ Group: 343118190, 662147501</li>
  545. </ul>
  546. </li>
  547. <li>Source Code:<a href="https://github.com/xmake-io/xmake">Github</a>, <a href="https://gitee.com/tboox/xmake">Gitee</a></li>
  548. <li>Wechat Public: tboox-os</li>
  549. </ul>
  550. <h2 id="thanks">Thanks</h2>
  551. <p>This project exists thanks to all the people who have <a href="CONTRIBUTING.md">contributed</a>:<br><a href="https://github.com/xmake-io/xmake/graphs/contributors"><img src="https://opencollective.com/xmake/contributors.svg?width=890&amp;button=false" /></a></p>
  552. <ul>
  553. <li><a href="https://github.com/TitanSnow">TitanSnow</a>: provide the xmake <a href="https://github.com/TitanSnow/ts-xmake-logo">logo</a> and install scripts</li>
  554. <li><a href="https://github.com/uael">uael</a>: provide the semantic versioning library <a href="https://github.com/uael/sv">sv</a></li>
  555. <li><a href="https://github.com/OpportunityLiu">OpportunityLiu</a>: improve cuda, tests and ci</li>
  556. <li><a href="https://github.com/xq114">xq144</a>: Improve <code>xrepo env shell</code>, and contribute a lot of packages to the <a href="https://github.com/xmake-io/xmake-repo">xmake-repo</a> repository.</li>
  557. </ul>
  558. </article>
  559. </body>
  560. </html>