quickstart.html 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  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/#/zh-cn/guide/quickstart">https://xmake.io/#/zh-cn/guide/quickstart</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="">用法视频</h2>
  86. <p><a href="https://asciinema.org/a/133693"><img src="https://asciinema.org/a/133693.png" alt="asciicast"></a></p>
  87. <h2 id="">创建工程</h2>
  88. <p>创建一个名叫<code>hello</code>的<code>c</code>控制台工程:</p>
  89. <pre><code class="lang-bash">$ xmake create -l c -P ./hello
  90. </code></pre>
  91. <p>执行完后,将会生成一个简单工程结构:</p>
  92. <pre><code>hello
  93. ├── src
  94. │ └── main.c
  95. └── xmake.lua
  96. </code></pre><p>其中<code>xmake.lua</code>是工程描述文件,内容非常简单,告诉xmake添加<code>src</code>目录下的所有<code>.c</code>源文件:</p>
  97. <pre><code class="lang-lua">target("hello")
  98. set_kind("binary")
  99. add_files("src/*.c")
  100. </code></pre>
  101. <p>目前支持的语言如下:</p>
  102. <ul>
  103. <li>c/c++</li>
  104. <li>objc/c++</li>
  105. <li>cuda</li>
  106. <li>asm</li>
  107. <li>swift</li>
  108. <li>dlang</li>
  109. <li>golang</li>
  110. <li>rust</li>
  111. </ul>
  112. <p>!> 如果你想了解更多参数选项,请运行: <code>xmake create --help</code></p>
  113. <h2 id="">构建工程</h2>
  114. <pre><code class="lang-bash">$ cd hello
  115. $ xmake
  116. </code></pre>
  117. <h2 id="">运行程序</h2>
  118. <pre><code class="lang-bash">$ xmake run hello
  119. </code></pre>
  120. <h2 id="">调试程序</h2>
  121. <p>首先你需要切换到 debug 模式去重新编译程序。</p>
  122. <pre><code class="lang-bash">$ xmake config -m debug
  123. $ xmake
  124. </code></pre>
  125. <p>然后执行下面的命令去开始调试:</p>
  126. <pre><code class="lang-bash">$ xmake run -d hello
  127. </code></pre>
  128. <p>Xmake 将会使用调试器去加载程序运行,目前支持:lldb, gdb, windbg, vsjitdebugger, ollydbg 等各种调试器。</p>
  129. <pre><code class="lang-bash">[lldb]$target create "build/hello"
  130. Current executable set to &#39;build/hello&#39; (x86_64).
  131. [lldb]$b main
  132. Breakpoint 1: where = hello`main, address = 0x0000000100000f50
  133. [lldb]$r
  134. Process 7509 launched: &#39;/private/tmp/hello/build/hello&#39; (x86_64)
  135. Process 7509 stopped
  136. * thread #1: tid = 0x435a2, 0x0000000100000f50 hello`main, queue = &#39;com.apple.main-thread&#39;, stop reason = breakpoint 1.1
  137. frame #0: 0x0000000100000f50 hello`main
  138. hello`main:
  139. -> 0x100000f50 <+0>: pushq %rbp
  140. 0x100000f51 <+1>: movq %rsp, %rbp
  141. 0x100000f54 <+4>: leaq 0x2b(%rip), %rdi ; "hello world!"
  142. 0x100000f5b <+11>: callq 0x100000f64 ; symbol stub for: puts
  143. [lldb]$
  144. </code></pre>
  145. <p>如果想要使用指定的调试器:</p>
  146. <pre><code class="lang-bash">$ xmake f --debugger=gdb
  147. $ xmake run -d hello
  148. </code></pre>
  149. <p>!> 你也可以使用简写的命令行选项,例如: <code>xmake r</code> 或者 <code>xmake run</code></p>
  150. </article>
  151. </body>
  152. </html>