summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorruki <[email protected]>2018-01-25 23:16:06 +0800
committerruki <[email protected]>2018-01-25 13:36:38 +0800
commit969e896da38d60040e7d17a142bcb2c1a7895f18 (patch)
tree281bf6c1250c2a8c1a8380569513c213d85cd514
parentd394e5ff46ff2856d2c8ae4772d2e84606449d32 (diff)
add plugin examples
-rw-r--r--README.md27
-rw-r--r--README_zh.md33
2 files changed, 52 insertions, 8 deletions
diff --git a/README.md b/README.md
index f4b2ff8a6..cf87d5419 100644
--- a/README.md
+++ b/README.md
@@ -137,10 +137,29 @@ $ xmake run -d console
## Builtin Plugins
-* Macros script plugin
-* Run the custom lua script plugin
-* Generate IDE project file plugin(makefile, vs2002 - vs2017 .. )
-* Generate doxygen document plugin
+#### Macros script plugin
+
+```bash
+$ xmake m -b # start to record
+$ xmake f -p iphoneos -m debug
+$ xmake
+$ xmake m -e # stop to record
+$ xmake m . # palyback commands
+```
+
+#### Run the custom lua script plugin
+
+```bash
+$ xmake l ./test.lua
+$ xmake l -c "print('hello xmake!')"
+$ xmake l lib.detect.find_tool gcc
+```
+
+#### Generate IDE project file plugin(makefile, vs2002 - vs2017 .. )
+
+```bash
+$ xmake project -k vs2017 -m "debug,release"
+```
## More Plugins
diff --git a/README_zh.md b/README_zh.md
index e0d51c70a..cd1ec64b6 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -143,10 +143,35 @@ $ xmake run -d console
## 内置插件
-* 宏记录脚本和回放插件
-* 加载自定义lua脚本插件
-* 生成IDE工程文件插件(makefile, vs2002 - vs2017, ...)
-* 生成doxygen文档插件
+#### 宏记录脚本和回放插件
+
+```bash
+$ xmake m -b # 开始记录
+$ xmake f -p iphoneos -m debug
+$ 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]
+```
## 更多插件