summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorruki <[email protected]>2020-01-10 23:49:31 +0800
committerruki <[email protected]>2020-01-10 16:57:07 +0800
commit2f72737cd44e1f17ad31f2c16cbb1c6a82d867ec (patch)
treec597b425b83932a0f2bed3513ec2dac22d1af683
parentf499ea91a2d969fc5356b1cad24612d7fd817bb7 (diff)
update readme
-rw-r--r--README.md144
-rw-r--r--README_zh.md144
2 files changed, 150 insertions, 138 deletions
diff --git a/README.md b/README.md
index 83fb4ce04..a0465ae49 100644
--- a/README.md
+++ b/README.md
@@ -165,7 +165,79 @@ $ xmake f --menu
* WinSDK Application
* MFC Application
-## Builtin Plugins
+## More Examples
+
+Debug and release modes:
+
+```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
+```
+
+Download and use packages in [xmake-repo](https://github.com/xmake-io/xmake-repo) or third-party repositories:
+
+```lua
+add_requires("tbox >1.6.1", "libuv master", "vcpkg::ffmpeg", "brew::pcre2/libpcre2-8", "zlib 1.20.*")
+add_requires("conan::OpenSSL/1.0.2n@conan/stable", {alias = "openssl", optional = true, debug = true})
+target("test")
+ set_kind("binary")
+ add_files("src/*.c")
+ add_packages("tbox", "libuv", "vcpkg::ffmpeg", "brew::pcre2/libpcre2-8", "openssl", "zlib")
+```
+
+Find and use local packages:
+
+```lua
+target("test")
+ set_kind("shared")
+ add_files("src/*.c")
+ on_load(function (target)
+ target:add(find_packages("zlib", "openssl", "brew::pcre2/libpcre2-8", "conan::OpenSSL/1.0.2n@conan/stable"))
+ end)
+```
+
+Qt QuickApp Program:
+
+```lua
+target("test")
+ add_rules("qt.quickapp")
+ add_files("src/*.cpp")
+ add_files("src/qml.qrc")
+```
+
+Cuda Program:
+
+```lua
+target("test")
+ set_kind("binary")
+ add_files("src/*.cu")
+ add_cugencodes("native")
+ add_cugencodes("compute_30")
+```
+
+WDK/UMDF Driver Program:
+
+```lua
+target("echo")
+ add_rules("wdk.driver", "wdk.env.umdf")
+ add_files("driver/*.c")
+ add_files("driver/*.inx")
+ add_includedirs("exe")
+
+target("app")
+ add_rules("wdk.binary", "wdk.env.umdf")
+ add_files("exe/*.cpp")
+```
+
+More wdk driver program examples (umdf/kmdf/wdm), please see [WDK Program Examples](https://xmake.io/#/guide/project_examples?id=wdk-driver-program)
+
+## Plugins
#### Generate IDE project file plugin(makefile, vs2002 - vs2019 .. )
@@ -175,18 +247,6 @@ $ xmake project -k cmakelists
$ xmake project -k compile_commands
```
-#### Macros script plugin
-
-```bash
-$ xmake m -b # start to record
-$ xmake f -p iphoneos -m debug
-$ xmake
-$ xmake f -p android --ndk=~/files/android-ndk-r16b
-$ xmake
-$ xmake m -e # stop to record
-$ xmake m . # playback commands
-```
-
#### Run the custom lua script plugin
```bash
@@ -195,15 +255,9 @@ $ xmake l -c "print('hello xmake!')"
$ xmake l lib.detect.find_tool gcc
```
-#### Generate doxygen document plugin
+More builtin plugins, please see: [Builtin plugins](https://xmake.io/#/plugin/builtin_plugins)
-```bash
-$ xmake doxygen [srcdir]
-```
-
-## More Plugins
-
-Please download and install from the plugins repository [xmake-plugins](https://github.com/xmake-io/xmake-plugins).
+Please download and install more other plugins from the plugins repository [xmake-plugins](https://github.com/xmake-io/xmake-plugins).
## IDE/Editor Integration
@@ -221,54 +275,6 @@ Please download and install from the plugins repository [xmake-plugins](https://
* [xmake.vim](https://github.com/luzhlon/xmake.vim) (third-party, thanks [@luzhlon](https://github.com/luzhlon))
-## More Examples
-
-Debug and release modes:
-
-```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
-```
-
-Download and use packages in [xmake-repo](https://github.com/xmake-io/xmake-repo):
-
-```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")
-```
-
-Download and use packages in third-party package manager:
-
-```lua
-add_requires("brew::pcre2/libpcre2-8", {alias = "pcre2"})
-add_requires("conan::OpenSSL/1.0.2n@conan/stable", {alias = "openssl"})
-target("test")
- set_kind("shared")
- add_files("src/*.c")
- add_packages("pcre2", "openssl")
-```
-
-Find and use local packages:
-
-```lua
-target("test")
- set_kind("shared")
- add_files("src/*.c")
- on_load(function (target)
- target:add(find_packages("zlib", "openssl", "brew::pcre2/libpcre2-8", "conan::OpenSSL/1.0.2n@conan/stable"))
- end)
-```
-
## Project Examples
Some projects using xmake:
diff --git a/README_zh.md b/README_zh.md
index ffaabe42c..f3724c386 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -170,7 +170,79 @@ $ xmake f --menu
* WinSDK应用程序
* MFC应用程序
-## 内置插件
+## 更多例子
+
+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
+```
+
+下载和使用在[xmake-repo](https://github.com/xmake-io/xmake-repo)和第三方包仓库的依赖包:
+
+```lua
+add_requires("tbox >1.6.1", "libuv master", "vcpkg::ffmpeg", "brew::pcre2/libpcre2-8", "zlib 1.20.*")
+add_requires("conan::OpenSSL/1.0.2n@conan/stable", {alias = "openssl", optional = true, debug = true})
+target("test")
+ set_kind("binary")
+ add_files("src/*.c")
+ add_packages("tbox", "libuv", "vcpkg::ffmpeg", "brew::pcre2/libpcre2-8", "openssl", "zlib")
+```
+
+查找和使用本地已安装的包:
+
+```lua
+target("test")
+ set_kind("shared")
+ add_files("src/*.c")
+ on_load(function (target)
+ target:add(find_packages("zlib", "openssl", "brew::pcre2/libpcre2-8", "conan::OpenSSL/1.0.2n@conan/stable"))
+ end)
+```
+
+Qt QuickApp应用程序:
+
+```lua
+target("test")
+ add_rules("qt.quickapp")
+ add_files("src/*.cpp")
+ add_files("src/qml.qrc")
+```
+
+Cuda程序:
+
+```lua
+target("test")
+ set_kind("binary")
+ add_files("src/*.cu")
+ add_cugencodes("native")
+ add_cugencodes("compute_30")
+```
+
+WDK/UMDF驱动程序:
+
+```lua
+target("echo")
+ add_rules("wdk.driver", "wdk.env.umdf")
+ add_files("driver/*.c")
+ add_files("driver/*.inx")
+ add_includedirs("exe")
+
+target("app")
+ add_rules("wdk.binary", "wdk.env.umdf")
+ add_files("exe/*.cpp")
+```
+
+更多WDK驱动程序例子(umdf/kmdf/wdm),见:[WDK工程例子](https://xmake.io/#/zh-cn/guide/project_examples?id=wdk%e9%a9%b1%e5%8a%a8%e7%a8%8b%e5%ba%8f)
+
+## 插件
#### 生成IDE工程文件插件(makefile, vs2002 - vs2019, ...)
@@ -180,18 +252,6 @@ $ xmake project -k cmakelists
$ xmake project -k compile_commands
```
-#### 宏记录脚本和回放插件
-
-```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
@@ -200,15 +260,9 @@ $ xmake l -c "print('hello xmake!')"
$ xmake l lib.detect.find_tool gcc
```
-#### 生成doxygen文档插件
+更多内置插件见相关文档:[内置插件文档](https://xmake.io/#/zh-cn/plugin/builtin_plugins)
-```bash
-$ xmake doxygen [srcdir]
-```
-
-## 更多插件
-
-请到插件仓库进行下载安装: [xmake-plugins](https://github.com/xmake-io/xmake-plugins).
+其他扩展插件,请到插件仓库进行下载安装: [xmake-plugins](https://github.com/xmake-io/xmake-plugins).
## IDE和编辑器插件
@@ -226,54 +280,6 @@ $ xmake doxygen [srcdir]
* [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
-```
-
-下载和使用在[xmake-repo](https://github.com/xmake-io/xmake-repo)的依赖包:
-
-```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
-add_requires("brew::pcre2/libpcre2-8", {alias = "pcre2"})
-add_requires("conan::OpenSSL/1.0.2n@conan/stable", {alias = "openssl"})
-target("test")
- set_kind("shared")
- add_files("src/*.c")
- add_packages("pcre2", "openssl")
-```
-
-查找和使用本地已安装的包:
-
-```lua
-target("test")
- set_kind("shared")
- add_files("src/*.c")
- on_load(function (target)
- target:add(find_packages("zlib", "openssl", "brew::pcre2/libpcre2-8", "conan::OpenSSL/1.0.2n@conan/stable"))
- end)
-```
-
## 项目例子
一些使用xmake的项目: