summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorruki <[email protected]>2019-04-09 22:21:18 +0800
committerruki <[email protected]>2019-04-09 08:07:50 +0800
commitf9c7fb65ae6aad57d05841e71fa915e9c6ee7d79 (patch)
tree56df59ad0fef275fabbde912bc670f91d8b69afb
parente27ac0a2f2bff920a5bdc8d8b542e29b59cc95f8 (diff)
update readme
-rw-r--r--README.md40
-rw-r--r--README_zh.md40
2 files changed, 44 insertions, 36 deletions
diff --git a/README.md b/README.md
index 8dcd18a3e..06891db0f 100644
--- a/README.md
+++ b/README.md
@@ -50,6 +50,8 @@ xmake is a cross-platform build utility based on lua.
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.
+<img src="https://xmake.io/assets/img/index/package_manage.png" width="80%" />
+
If you want to known more, please refer to:
* [Documents](https://xmake.io/#/home)
@@ -57,16 +59,6 @@ If you want to known more, please refer to:
* [Github](https://github.com/xmake-io/xmake)
* [Gitee](https://gitee.com/tboox/xmake)
-```
- _
- __ ___ __ __ __ _| | ______
- \ \/ / | \/ |/ _ | |/ / __ \
- > < | \__/ | /_| | < ___/
- /_/\_\_|_| |_|\__ \|_|\_\____|
-
- by ruki, tboox.org
-```
-
## Installation
#### via curl
@@ -165,9 +157,18 @@ $ xmake f --menu
* Qt Application
* WDK Driver (umdf/kmdf/wdm)
* WinSDK Application
+* MFC Application
## Builtin Plugins
+#### Generate IDE project file plugin(makefile, vs2002 - vs2019 .. )
+
+```bash
+$ xmake project -k vs2017 -m "debug,release"
+$ xmake project -k cmakelists
+$ xmake project -k compile_commands
+```
+
#### Macros script plugin
```bash
@@ -188,12 +189,6 @@ $ 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"
-```
-
#### Generate doxygen document plugin
```bash
@@ -235,17 +230,26 @@ target("console")
end
```
-Download and use remote packages:
+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("libuv", "ffmpeg", "tbox", "zlib", "pcre2", "openssl")
+ add_packages("pcre2", "openssl")
```
Find and use local packages:
diff --git a/README_zh.md b/README_zh.md
index e21a2b943..3dbce2408 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -56,6 +56,8 @@ xmake的目标是开发者更加关注于项目本身开发,简化项目的描
不仅如此,它还提供了许多更加高级的特性,例如插件扩展、脚本宏记录、批量打包、自动文档生成等等。。
+<img src="https://xmake.io/assets/img/index/package_manage.png" width="80%" />
+
如果你想要了解更多,请参考:
* [在线文档](https://xmake.io/#/zh/)
@@ -63,16 +65,6 @@ xmake的目标是开发者更加关注于项目本身开发,简化项目的描
* [Github](https://github.com/xmake-io/xmake)
* [Gitee](https://gitee.com/tboox/xmake)
-```
- _
- __ ___ __ __ __ _| | ______
- \ \/ / | \/ |/ _ | |/ / __ \
- > < | \__/ | /_| | < ___/
- /_/\_\_|_| |_|\__ \|_|\_\____|
-
- by ruki, tboox.org
-```
-
## 安装
#### 使用curl
@@ -170,9 +162,18 @@ $ xmake f --menu
* Qt应用程序
* WDK驱动程序
* WinSDK应用程序
+* MFC应用程序
## 内置插件
+#### 生成IDE工程文件插件(makefile, vs2002 - vs2019, ...)
+
+```bash
+$ xmake project -k vs2017 -m "debug,release"
+$ xmake project -k cmakelists
+$ xmake project -k compile_commands
+```
+
#### 宏记录脚本和回放插件
```bash
@@ -193,12 +194,6 @@ $ 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
@@ -240,17 +235,26 @@ target("console")
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("libuv", "ffmpeg", "tbox", "zlib", "pcre2", "openssl")
+ add_packages("pcre2", "openssl")
```
查找和使用本地已安装的包: