first commit

author: ruki <waruqi@gmail.com> 2017-08-31 09:08:38 +0800
committer: ruki <waruqi@gmail.com> 2017-08-31 09:08:38 +0800
commit: 9078c01303c065fbf6e6cefbddcb462adede7bfb (patch)
tree: c33052b914aeaca00186e6cc83df6f88f4e1c1b4 /landing.html
download: xmake-docs-9078c01303c065fbf6e6cefbddcb462adede7bfb.tar.gz
xmake-docs-9078c01303c065fbf6e6cefbddcb462adede7bfb.zip
1 files changed, 234 insertions, 0 deletions
diff --git a/landing.html b/landing.html
new file mode 100644
index 00000000..79cb86df
--- /dev/null
+++ b/landing.html
@@ -0,0 +1,234 @@
+<!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="A cross-platform build utility based on Lua">
+  <meta name="keywords" content="make,makefile,build,lua,cross-compile,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">A cross-platform build utility based on Lua</h2>
+  <a href="/#/home" class="btn">GET STARTED</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: 100px">
+      <img src="/assets/img/patreon.png">
+      <a href="/pages/donation.html#donate">Support us</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="installation">Installation</h2>
+
+<h4 id="via-curl">via curl</h4>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code>bash &lt;<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="via-wget">via wget</h4>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code>bash &lt;<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="via-powershell">via 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="simple-description">Simple description</h2>
+
+<div class="language-lua highlighter-rouge"><pre class="highlight"><code><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> 
+</code></pre>
+</div>
+
+<h2 id="build-project">Build project</h2>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>xmake
+</code></pre>
+</div>
+
+<h2 id="run-target">Run target</h2>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>xmake run console
+</code></pre>
+</div>
+
+<h2 id="debug-target">Debug target</h2>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>xmake run -d console
+</code></pre>
+</div>
+
+<h2 id="support-features">Support features</h2>
+
+<ul>
+  <li>Tasks</li>
+  <li>Macros</li>
+  <li>Actions</li>
+  <li>Options</li>
+  <li>Plugins</li>
+  <li>Modules</li>
+  <li>Templates</li>
+</ul>
+
+<h2 id="support-platforms">Support platforms</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="support-languages">Support Languages</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>
+</ul>
+
+<h2 id="builtin-plugins">Builtin Plugins</h2>
+
+<ul>
+  <li>Macros script plugin</li>
+  <li>Run the custom lua script plugin</li>
+  <li>Generate IDE project file plugin（makefile, vs2002 - vs2017 .. ）</li>
+  <li>Generate doxygen document plugin</li>
+</ul>
+
+<h2 id="more-plugins">More Plugins</h2>
+
+<p>Please download and install from the plugins repository <a href="https://github.com/tboox/xmake-plugins">xmake-plugins</a>.</p>
+
+<h2 id="more-examples">More Examples</h2>
+
+<p>Debug and release modes:</p>
+
+<div class="language-lua highlighter-rouge"><pre class="highlight"><code><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">set_symbols</span><span class="p">(</span><span class="s2">"debug"</span><span class="p">)</span>
+    <span class="n">set_optimize</span><span class="p">(</span><span class="s2">"none"</span><span class="p">)</span>
+<span class="k">end</span>
+
+<span class="k">if</span> <span class="n">is_mode</span><span class="p">(</span><span class="s2">"release"</span><span class="p">)</span> <span class="k">then</span>
+    <span class="n">set_symbols</span><span class="p">(</span><span class="s2">"hidden"</span><span class="p">)</span>
+    <span class="n">set_optimize</span><span class="p">(</span><span class="s2">"fastest"</span><span class="p">)</span>
+    <span class="n">set_strip</span><span class="p">(</span><span class="s2">"all"</span><span class="p">)</span>
+<span class="k">end</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> 
+</code></pre>
+</div>
+
+<p>Custom script:</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">"static"</span><span class="p">)</span>
+    <span class="n">add_files</span><span class="p">(</span><span class="s2">"src/*.cpp"</span><span class="p">)</span>
+    <span class="n">after_build</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="nb">print</span><span class="p">(</span><span class="s2">"build %s ok!"</span><span class="p">,</span> <span class="n">target</span><span class="p">:</span><span class="n">targetfile</span><span class="p">())</span>
+    <span class="k">end</span><span class="p">)</span>
+</code></pre>
+</div>
+
+<p>Extension Modules:</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="k">end</span><span class="p">)</span>
+</code></pre>
+</div>
+
+<h2 id="project-examples">Project Examples</h2>
+
+<p>Some projects using 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/xmake/wiki/xmake-projects">more</a></li>
+</ul>
+
+<h2 id="example-video">Example Video</h2>
+
+<p><a href="https://asciinema.org/a/133693"><img src="https://asciinema.org/a/133693.png" alt="asciicast" /></a></p>
+
+<h2 id="contacts">Contacts</h2>
+
+<ul>
+  <li>Email：<a href="mailto:waruqi@gmail.com">waruqi@gmail.com</a></li>
+  <li>Homepage：<a href="http://www.tboox.org">tboox.org</a></li>
+  <li>Community：<a href="https://github.com/tboox/community/issues">tboox@community</a></li>
+  <li>ChatRoom：<a href="https://gitter.im/tboox/tboox?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img src="https://badges.gitter.im/tboox/tboox.svg" alt="Join the chat at https://gitter.im/tboox/tboox" /></a></li>
+  <li>Source Code：<a href="https://github.com/tboox/xmake">Github</a>, <a href="https://gitee.com/tboox/xmake">Gitee</a></li>
+</ul>
+
+
+      <footer class="site-footer">
+  <span class="site-footer-owner">Copyright (c) 2015-2017 <a href="http://www.tboox.org">tboox.org</a>.</span>
+  <span class="site-footer-power">
+    <span>
+        <!--Site powered by <a href="https://jekyllrb.com/">Jekyll</a> & <a href="http://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>
author	ruki <waruqi@gmail.com>	2017-08-31 09:08:38 +0800
committer	ruki <waruqi@gmail.com>	2017-08-31 09:08:38 +0800
commit	9078c01303c065fbf6e6cefbddcb462adede7bfb (patch)
tree	c33052b914aeaca00186e6cc83df6f88f4e1c1b4 /landing.html
download	xmake-docs-9078c01303c065fbf6e6cefbddcb462adede7bfb.tar.gz xmake-docs-9078c01303c065fbf6e6cefbddcb462adede7bfb.zip