diff options
| author | ruki <[email protected]> | 2017-08-27 21:44:26 +0800 |
|---|---|---|
| committer | ruki <[email protected]> | 2017-08-27 21:44:26 +0800 |
| commit | 82656cd001b02abd7f1a4b5ba6dcd89c50899d46 (patch) | |
| tree | 306c4acfc3e7d123a6c742d531aa02fbd7201132 /docs | |
| parent | d3f38de4ea68ca59a74bb8a96ea3ffe4db2563f6 (diff) | |
update description and index
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 2 | ||||
| -rw-r--r-- | docs/cn/index.html | 60 | ||||
| -rw-r--r-- | docs/landing.html | 58 | ||||
| -rw-r--r-- | docs/landing/index.cn.md | 56 | ||||
| -rw-r--r-- | docs/landing/index.md | 56 |
5 files changed, 226 insertions, 6 deletions
diff --git a/docs/README.md b/docs/README.md index 372cdad34..a8552c9c9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -39,7 +39,7 @@ search: en </a> </div> - <p>A make-like build utility based on Lua</p> + <p>A cross-platform build utility based on Lua</p> </div> </p> diff --git a/docs/cn/index.html b/docs/cn/index.html index 252376f9e..4b0cd2dec 100644 --- a/docs/cn/index.html +++ b/docs/cn/index.html @@ -103,6 +103,7 @@ <li>Actions</li> <li>Options</li> <li>Plugins</li> + <li>Modules</li> <li>Templates</li> </ul> @@ -143,11 +144,66 @@ <p>请到插件仓库进行下载安装: <a href="https://github.com/tboox/xmake-plugins">xmake-plugins</a>.</p> -<h2 id="section-10">使用演示</h2> +<h2 id="section-10">更多例子</h2> + +<p>Debug和Release模式:</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>自定义脚本:</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>使用扩展模块:</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="section-11">项目例子</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/vm86/xmake/wiki/%E4%BD%BF%E7%94%A8xmake%E7%9A%84%E5%BC%80%E6%BA%90%E5%BA%93">更多</a></li> +</ul> + +<h2 id="section-12">演示视频</h2> <p><a href="https://asciinema.org/a/133693"><img src="https://asciinema.org/a/133693.png" alt="asciicast" /></a></p> -<h2 id="section-11">联系方式</h2> +<h2 id="section-13">联系方式</h2> <ul> <li>邮箱:<a href="mailto:[email protected]">[email protected]</a></li> diff --git a/docs/landing.html b/docs/landing.html index a01ecdb21..68c915aad 100644 --- a/docs/landing.html +++ b/docs/landing.html @@ -103,6 +103,7 @@ <li>Actions</li> <li>Options</li> <li>Plugins</li> + <li>Modules</li> <li>Templates</li> </ul> @@ -143,7 +144,62 @@ <p>Please download and install from the plugins repository <a href="https://github.com/tboox/xmake-plugins">xmake-plugins</a>.</p> -<h2 id="examples">Examples</h2> +<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> diff --git a/docs/landing/index.cn.md b/docs/landing/index.cn.md index 91b04379a..86c9ad982 100644 --- a/docs/landing/index.cn.md +++ b/docs/landing/index.cn.md @@ -56,6 +56,7 @@ $ xmake run -d console * Actions * Options * Plugins +* Modules * Templates ## 支持平台 @@ -89,7 +90,60 @@ $ xmake run -d console 请到插件仓库进行下载安装: [xmake-plugins](https://github.com/tboox/xmake-plugins). -## 使用演示 +## 更多例子 + +Debug和Release模式: + +```lua +if is_mode("debug") then + set_symbols("debug") + set_optimize("none") +end + +if is_mode("release") then + set_symbols("hidden") + set_optimize("fastest") + set_strip("all") +end + +target("console") + set_kind("binary") + add_files("src/*.c") +``` + +自定义脚本: + +```lua +target("test") + set_kind("static") + add_files("src/*.cpp") + after_build(function (target) + print("build %s ok!", target:targetfile()) + end) +``` + +使用扩展模块: + +```lua +target("test") + set_kind("shared") + add_files("src/*.c") + on_load(function (target) + import("lib.detect.find_package") + target:add(find_package("zlib")) + end) +``` + +## 项目例子 + +一些使用xmake的项目: + +* [tbox](https://github.com/tboox/tbox) +* [gbox](https://github.com/tboox/gbox) +* [vm86](https://github.com/tboox/vm86) +* [更多](https://github.com/vm86/xmake/wiki/%E4%BD%BF%E7%94%A8xmake%E7%9A%84%E5%BC%80%E6%BA%90%E5%BA%93) + +## 演示视频 [](https://asciinema.org/a/133693) diff --git a/docs/landing/index.md b/docs/landing/index.md index a10779237..3c55aa14a 100644 --- a/docs/landing/index.md +++ b/docs/landing/index.md @@ -56,6 +56,7 @@ $ xmake run -d console * Actions * Options * Plugins +* Modules * Templates ## Support platforms @@ -89,7 +90,60 @@ $ xmake run -d console Please download and install from the plugins repository [xmake-plugins](https://github.com/tboox/xmake-plugins). -## Examples +## More Examples + +Debug and release modes: + +```lua +if is_mode("debug") then + set_symbols("debug") + set_optimize("none") +end + +if is_mode("release") then + set_symbols("hidden") + set_optimize("fastest") + set_strip("all") +end + +target("console") + set_kind("binary") + add_files("src/*.c") +``` + +Custom script: + +```lua +target("test") + set_kind("static") + add_files("src/*.cpp") + after_build(function (target) + print("build %s ok!", target:targetfile()) + end) +``` + +Extension Modules: + +```lua +target("test") + set_kind("shared") + add_files("src/*.c") + on_load(function (target) + import("lib.detect.find_package") + target:add(find_package("zlib")) + end) +``` + +## Project Examples + +Some projects using xmake: + +* [tbox](https://github.com/tboox/tbox) +* [gbox](https://github.com/tboox/gbox) +* [vm86](https://github.com/tboox/vm86) +* [more](https://github.com/tboox/xmake/wiki/xmake-projects) + +## Example Video [](https://asciinema.org/a/133693) |
