From 6f7387e12aeac26276b520137101b7f97f1d2ada Mon Sep 17 00:00:00 2001 From: ruki Date: Sun, 23 Jun 2019 20:48:18 +0800 Subject: fix some links --- zh-cn/README.md | 215 -------------------------------------- zh-cn/_coverpage.md | 5 +- zh-cn/getting_started.md | 215 ++++++++++++++++++++++++++++++++++++++ zh-cn/guide/package_management.md | 6 +- zh-cn/guide/syntax_description.md | 4 +- 5 files changed, 222 insertions(+), 223 deletions(-) delete mode 100644 zh-cn/README.md create mode 100644 zh-cn/getting_started.md (limited to 'zh-cn') diff --git a/zh-cn/README.md b/zh-cn/README.md deleted file mode 100644 index 8d0b861c..00000000 --- a/zh-cn/README.md +++ /dev/null @@ -1,215 +0,0 @@ -## 安装 - -#### 使用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 -``` - -## 简单的工程描述 - - - -## 包依赖描述 - - - -官方的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 -``` - - - -## 包依赖管理 - - - -## 支持平台 - -* 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) - - - -* [xmake-sublime](https://github.com/xmake-io/xmake-sublime) - - - -* [xmake-idea](https://github.com/xmake-io/xmake-idea) - - - -* [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) - -## 演示视频 - - - - - -## 联系方式 - -* 邮箱：[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/_coverpage.md b/zh-cn/_coverpage.md index 80098b33..ad280313 100644 --- a/zh-cn/_coverpage.md +++ b/zh-cn/_coverpage.md @@ -4,9 +4,8 @@ > 一个基于Lua的轻量级跨平台自动构建工具 -- 语法简洁，快速上手 -- 跨平台构建，全平台覆盖 +- 简单，快速，跨平台 - 现代化的C/C++构建工具，多语言混合编译支持 [GitHub](https://github.com/xmake-io/xmake/) -[快速开始](/zh-cn/guide/installation) +[快速开始](/zh-cn/getting_started) diff --git a/zh-cn/getting_started.md b/zh-cn/getting_started.md new file mode 100644 index 00000000..8d0b861c --- /dev/null +++ b/zh-cn/getting_started.md @@ -0,0 +1,215 @@ +## 安装 + +#### 使用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 +``` + +## 简单的工程描述 + + + +## 包依赖描述 + + + +官方的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 +``` + + + +## 包依赖管理 + + + +## 支持平台 + +* 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) + + + +* [xmake-sublime](https://github.com/xmake-io/xmake-sublime) + + + +* [xmake-idea](https://github.com/xmake-io/xmake-idea) + + + +* [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) + +## 演示视频 + + + + + +## 联系方式 + +* 邮箱：[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/guide/package_management.md b/zh-cn/guide/package_management.md index 6f1a8188..02a8e280 100644 --- a/zh-cn/guide/package_management.md +++ b/zh-cn/guide/package_management.md @@ -21,7 +21,7 @@ add_packagedirs("packages") ``` -指定好后，就可以在target作用域中，通过[add_packages](https://xmake.io/#/zh/manual?id=targetadd_packages)接口，来添加集成包依赖了，例如： +指定好后，就可以在target作用域中，通过[add_packages](/zh-cn/manual/project_target?id=targetadd_packages)接口，来添加集成包依赖了，例如： ```lua target("tbox") @@ -42,7 +42,7 @@ $ cd tbox $ xmake package -o ../test/packages ``` -这样，test工程就可以通过[add_packages](https://xmake.io/#/zh/manual?id=targetadd_packages)和[add_packagedirs](https://xmake.io/#/zh/manual?id=add_packagedirs)去配置和使用tbox.pkg包了。 +这样，test工程就可以通过[add_packages]((/zh-cn/manual/project_target?id=targetadd_packages)和[add_packagedirs](/zh-cn/manual/global_interfaces?id=add_packagedirs)去配置和使用tbox.pkg包了。 关于内置包的详细描述，还可以参考下相关文章，这里面有详细介绍：[依赖包的添加和自动检测机制](https://tboox.org/cn/2016/08/06/add-package-and-autocheck/) @@ -92,7 +92,7 @@ target("test") 如果系统上装有`homebrew`, `pkg-config`等第三方工具，那么此接口会尝试使用它们去改进查找结果。 -更完整的使用描述，请参考：[find_packages](https://xmake.io/#/zh/manual?id=find_packages)接口文档。 +更完整的使用描述，请参考：[find_packages](/zh-cn/manual/builtin_modules?id=find_packages)接口文档。 ##### homebrew集成支持 diff --git a/zh-cn/guide/syntax_description.md b/zh-cn/guide/syntax_description.md index 92232946..30fe5f80 100644 --- a/zh-cn/guide/syntax_description.md +++ b/zh-cn/guide/syntax_description.md @@ -79,7 +79,7 @@ target("demo") - print - os -当然虽然内置lua api提供不多，但xmake还提供了很多扩展api，像描述api就不多说，详细可参考：[API手册](https://xmake.io/#/zh/manual) +当然虽然内置lua api提供不多，但xmake还提供了很多扩展api，像描述api就不多说，详细可参考：[API手册](/zh-cn/manual) 还有些辅助api，例如： @@ -135,7 +135,7 @@ task("hello") 在此作用域中，不仅可以使用大部分lua的api，还可以使用很多xmake提供的扩展模块，所有扩展模块，通过import来导入 -具体可参考：[import模块导入文档](https://xmake.io/#/zh/manual?id=import) +具体可参考：[import模块导入文档](/zh-cn/manual/builtin_modules?id=import) 这里我们给个简单的例子，在编译完成后，对ios目标程序进行ldid签名： -- cgit v1.2.3