aboutsummaryrefslogtreecommitdiff
path: root/zh-cn
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2019-06-23 10:11:49 +0800
committerruki <waruqi@gmail.com>2019-06-23 10:11:49 +0800
commit151abcd668b6eb129acb0bc028e0bef3ed87bd35 (patch)
tree631e1a1921ff65322f3f19e437d0c914f3f4ddbc /zh-cn
parent516f960821060415426dfaab2577da29bdfd12cc (diff)
downloadxmake-docs-151abcd668b6eb129acb0bc028e0bef3ed87bd35.tar.gz
xmake-docs-151abcd668b6eb129acb0bc028e0bef3ed87bd35.zip
fix some links
Diffstat (limited to 'zh-cn')
-rw-r--r--zh-cn/README.md216
-rw-r--r--zh-cn/about/contact.md12
-rw-r--r--zh-cn/about/introduction.md12
-rw-r--r--zh-cn/about/sponsor.md28
4 files changed, 245 insertions, 23 deletions
diff --git a/zh-cn/README.md b/zh-cn/README.md
index 2458cc9f..8d0b861c 100644
--- a/zh-cn/README.md
+++ b/zh-cn/README.md
@@ -1,3 +1,215 @@
-# 中文
+## 安装
-> An awesome project.
+#### 使用curl
+
+```bash
+bash <(curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh)
+```
+
+#### 使用wget
+
+```bash
+bash <(wget https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh -O -)
+```
+
+#### 使用powershell
+
+```bash
+Invoke-Expression (Invoke-Webrequest 'https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.ps1' -UseBasicParsing).Content
+```
+
+## 简单的工程描述
+
+<img src="/assets/img/index/showcode1.png" width="40%" />
+
+## 包依赖描述
+
+<img src="/assets/img/index/add_require.png" width="70%" />
+
+官方的xmake包管理仓库: [xmake-repo](https://github.com/xmake-io/xmake-repo)
+
+## 构建工程
+
+```bash
+$ xmake
+```
+
+## 运行目标
+
+```bash
+$ xmake run console
+```
+
+## 调试程序
+
+```bash
+$ xmake run -d console
+```
+
+## 配置平台
+
+```bash
+$ xmake f -p [windows|linux|macosx|android|iphoneos ..] -a [x86|arm64 ..] -m [debug|release]
+$ xmake
+```
+
+## 图形化菜单配置
+
+```bash
+$ xmake f --menu
+```
+
+<img src="/assets/img/index/menuconf.png" width="80%" />
+
+## 包依赖管理
+
+<img src="/assets/img/index/package_manage.png" width="80%" />
+
+## 支持平台
+
+* Windows (x86, x64)
+* Macosx (i386, x86_64)
+* Linux (i386, x86_64, cross-toolchains ...)
+* Android (armv5te, armv6, armv7-a, armv8-a, arm64-v8a)
+* iPhoneOS (armv7, armv7s, arm64, i386, x86_64)
+* WatchOS (armv7k, i386)
+* Mingw (i386, x86_64)
+
+## 支持语言
+
+* C/C++
+* Objc/Objc++
+* Swift
+* Assembly
+* Golang
+* Rust
+* Dlang
+* Cuda
+
+## 工程类型
+
+* 静态库程序
+* 动态库类型
+* 控制台程序
+* Cuda程序
+* Qt应用程序
+* WDK驱动程序
+* WinSDK应用程序
+
+## 内置插件
+
+#### 宏记录脚本和回放插件
+
+```bash
+$ xmake m -b # 开始记录
+$ xmake f -p iphoneos -m debug
+$ xmake
+$ xmake f -p android --ndk=~/files/android-ndk-r16b
+$ xmake
+$ xmake m -e # 结束记录
+$ xmake m . # 回放命令
+```
+
+#### 加载自定义lua脚本插件
+
+```bash
+$ xmake l ./test.lua
+$ xmake l -c "print('hello xmake!')"
+$ xmake l lib.detect.find_tool gcc
+```
+
+#### 生成IDE工程文件插件(makefile, vs2002 - vs2017, ...)
+
+```bash
+$ xmake project -k vs2017 -m "debug,release"
+```
+
+#### 生成doxygen文档插件
+
+```bash
+$ xmake doxygen [srcdir]
+```
+
+## 更多插件
+
+请到插件仓库进行下载安装: [xmake-plugins](https://github.com/xmake-io/xmake-plugins).
+
+## IDE和编辑器插件
+
+* [xmake-vscode](https://github.com/xmake-io/xmake-vscode)
+
+<img src="https://raw.githubusercontent.com/tboox/xmake-vscode/master/res/problem.gif" width="60%" />
+
+* [xmake-sublime](https://github.com/xmake-io/xmake-sublime)
+
+<img src="https://raw.githubusercontent.com/tboox/xmake-sublime/master/res/problem.gif" width="60%" />
+
+* [xmake-idea](https://github.com/xmake-io/xmake-idea)
+
+<img src="https://raw.githubusercontent.com/tboox/xmake-idea/master/res/problem.gif" width="60%" />
+
+* [xmake.vim](https://github.com/luzhlon/xmake.vim) (third-party, thanks [@luzhlon](https://github.com/luzhlon))
+
+## 更多例子
+
+Debug和Release模式:
+
+```lua
+add_rules("mode.debug", "mode.release")
+
+target("console")
+ set_kind("binary")
+ add_files("src/*.c")
+ if is_mode("debug") then
+ add_defines("DEBUG")
+ end
+```
+
+下载和使用远程依赖包:
+
+```lua
+add_requires("libuv master", "ffmpeg", "zlib 1.20.*")
+add_requires("tbox >1.6.1", {optional = true, debug = true})
+target("test")
+ set_kind("shared")
+ add_files("src/*.c")
+ add_packages("libuv", "ffmpeg", "tbox", "zlib")
+```
+
+查找和使用本地已安装的包:
+
+```lua
+target("test")
+ set_kind("shared")
+ add_files("src/*.c")
+ on_load(function (target)
+ import("lib.detect.find_package")
+ target:add(find_package("zlib"))
+ target:add(find_package("openssl"))
+ end)
+```
+
+## 项目例子
+
+一些使用xmake的项目:
+
+* [tbox](https://github.com/tboox/tbox)
+* [gbox](https://github.com/tboox/gbox)
+* [vm86](https://github.com/tboox/vm86)
+* [更多](https://github.com/tboox/awesome-xmake)
+
+## 演示视频
+
+<a href="https://asciinema.org/a/133693">
+<img src="https://asciinema.org/a/133693.png" width="60%" />
+</a>
+
+## 联系方式
+
+* 邮箱:[waruqi@gmail.com](mailto:waruqi@gmail.com)
+* 主页:[tboox.org](https://tboox.org/cn)
+* 社区:[Reddit论坛](https://www.reddit.com/r/tboox/)
+* 聊天:[Telegram群组](https://t.me/tbooxorg), [Gitter聊天室](https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+* 源码:[Github](https://github.com/xmake-io/xmake), [Gitee](https://gitee.com/tboox/xmake)
+* QQ群:343118190
+* 微信公众号:tboox-os
diff --git a/zh-cn/about/contact.md b/zh-cn/about/contact.md
index 94ffcf1f..44bcdba3 100644
--- a/zh-cn/about/contact.md
+++ b/zh-cn/about/contact.md
@@ -1,6 +1,8 @@
-* Email:[waruqi@gmail.com](mailto:waruqi@gmail.com)
-* Homepage:[tboox.org](https://tboox.org)
-* Community:[/r/tboox on reddit](https://www.reddit.com/r/tboox/)
-* ChatRoom:[Char on telegram](https://t.me/tbooxorg), [Chat on gitter](https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-* Source Code:[Github](https://github.com/xmake-io/xmake), [Gitee](https://gitee.com/tboox/xmake)
+* 邮箱:[waruqi@gmail.com](mailto:waruqi@gmail.com)
+* 主页:[tboox.org](https://tboox.org/cn)
+* 社区:[Reddit论坛](https://www.reddit.com/r/tboox/)
+* 聊天:[Telegram群组](https://t.me/tbooxorg), [Gitter聊天室](https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+* 源码:[Github](https://github.com/xmake-io/xmake), [Gitee](https://gitee.com/tboox/xmake)
+* QQ群:343118190
+* 微信公众号:tboox-os
diff --git a/zh-cn/about/introduction.md b/zh-cn/about/introduction.md
index 3454127b..7b90bc29 100644
--- a/zh-cn/about/introduction.md
+++ b/zh-cn/about/introduction.md
@@ -1,5 +1,11 @@
-xmake is a cross-platform build utility based on lua.
+XMake是一个基于Lua的轻量级跨平台自动构建工具,支持在各种主流平台上构建项目
+
+xmake的目标是开发者更加关注于项目本身开发,简化项目的描述和构建,并且提供平台无关性,使得一次编写,随处构建
+
+它跟cmake、automake、premake有点类似,但是机制不同,它默认不会去生成IDE相关的工程文件,采用直接编译,并且更加的方便易用 采用lua的工程描述语法更简洁直观,支持在大部分常用平台上进行构建,以及交叉编译
+
+并且xmake提供了创建、配置、编译、打包、安装、卸载、运行等一些actions,使得开发和构建更加的方便和流程化。
+
+不仅如此,它还提供了许多更加高级的特性,例如插件扩展、脚本宏记录、批量打包、自动文档生成等等。。
-The project focuses on making development and building easier and provides many features (.e.g package, install, plugin, macro, action, option, task ...),
-so that any developer can quickly pick it up and enjoy the productivity boost when developing and building project.
diff --git a/zh-cn/about/sponsor.md b/zh-cn/about/sponsor.md
index 33288406..f2858fb6 100644
--- a/zh-cn/about/sponsor.md
+++ b/zh-cn/about/sponsor.md
@@ -19,19 +19,21 @@ xmake项目属于个人开源项目,它的发展需要您的帮助,如果您
<a href="https://opencollective.com/xmake#backers" target="_blank"><img src="https://opencollective.com/xmake/backers.svg?width=890"></a>
-| 2019.06.19 | 匿名 | 微信 | ¥10 | 比cmake好用 |
-| 2018.11.16 | 孙果 | 微信 | ¥10 | xmake很好用,加油!|
-| 2018.10.17 | 红红 | 微信 | ¥100 | |
-| 2018.10.15 | xtvjxk | 支付宝 | ¥10 | 希望越来越好用 |
-| 2018.08.07 | fasiondog | gitee | ¥50 | 感谢您的开源项目! |
-| 2018.06.27 | Kellygod | 支付宝 | ¥30 | 拥抱xmake |
-| 2018.05.17 | 匿名 | 微信 | ¥10 | 加油xmake |
-| 2018.04.29 | 清春 | 支付宝 | ¥180 | |
-| 2018.02.18 | 氧烷 | 支付宝 | ¥16.66 | xmake,赞👍 |
-| 2017.11.19 | sytru | 支付宝 | ¥10 | 感谢作者,让写c/c++有了写脚本的感觉。非常愉悦的使用体验,希望不要消失。|
-| 2017.11.16 | 琪峻 | 支付宝 | ¥15 | 感谢好用的xmake |
-| 2017.10.26 | Welthy | 支付宝 | ¥5 | xmake很好用啊 |
-| 2016.11.10 | [lc-soft](https://github.com/lc-soft) | oschina | ¥10 | |
+| 日期 | 支持者 | 渠道 | 金额 | 评价 |
+|-- | -- | -- | -- | -- |
+| 2019.06.19 | 匿名 | 微信 | ¥10 | 比cmake好用 |
+| 2018.11.16 | 孙果 | 微信 | ¥10 | xmake很好用,加油! |
+| 2018.10.17 | 红红 | 微信 | ¥100 | |
+| 2018.10.15 | xtvjxk | 支付宝 | ¥10 | 希望越来越好用 |
+| 2018.08.07 | fasiondog | gitee | ¥50 | 感谢您的开源项目! |
+| 2018.06.27 | Kellygod | 支付宝 | ¥30 | 拥抱xmake |
+| 2018.05.17 | 匿名 | 微信 | ¥10 | 加油xmake |
+| 2018.04.29 | 清春 | 支付宝 | ¥180 | |
+| 2018.02.18 | 氧烷 | 支付宝 | ¥16.66 | xmake,赞👍 |
+| 2017.11.19 | sytru | 支付宝 | ¥10 | 感谢作者,让写c/c++有了写脚本的感觉。非常愉悦的使用体验,希望不要消失。 |
+| 2017.11.16 | 琪峻 | 支付宝 | ¥15 | 感谢好用的xmake |
+| 2017.10.26 | Welthy | 支付宝 | ¥5 | xmake很好用啊 |
+| 2016.11.10 | [lc-soft](https://github.com/lc-soft) | oschina | ¥10 | |
## 赞助者