summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorruki <[email protected]>2020-08-06 23:08:15 +0800
committerruki <[email protected]>2020-08-06 23:08:15 +0800
commitfa3a4a54ef3728e9f566082b414c475276806712 (patch)
tree1cfff2776018a2218b7c75c45405c36a4f7d289a
parent274bdc348143e94ccb1aaf6583ae0aec4aa1daef (diff)
update readme
-rw-r--r--README.md7
-rw-r--r--README_zh.md11
2 files changed, 7 insertions, 11 deletions
diff --git a/README.md b/README.md
index 4cc4c8240..2f587eabe 100644
--- a/README.md
+++ b/README.md
@@ -62,10 +62,11 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
## Introduction ([中文](/README_zh.md))
-xmake is a cross-platform build utility based on lua.
+xmake is a lightweight cross-platform build utility based on Lua. It uses xmake.lua to maintain project builds. Compared with makefile/CMakeLists.txt, the configuration syntax is more concise and intuitive. It is very friendly to novices and can quickly get started in a short time. Let users focus more on actual project development.
-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 a productivity boost when developing and building projects.
+Although simple and easy is a major feature of xmake, the function of xmake is also very powerful. It can directly compile projects like Make/Ninja, or generate project files like CMake/Meson, as well as built-in package management. The system helps users solve the problem of integrated use of C/C++ dependent libraries.
+
+At present, xmake is mainly used for the compilation of C/C++ projects, but it also supports the compilation of other native languages, which can support mixed compilation with C/C++, and the compilation speed is also very fast, which can be equal to Ninja.
If you want to know more, please refer to: [Documents](https://xmake.io/#/home), [Github](https://github.com/xmake-io/xmake) and [Gitee](https://gitee.com/tboox/xmake)
diff --git a/README_zh.md b/README_zh.md
index 8c3077288..2af5c06fc 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -62,16 +62,11 @@ xmake由以下工具赞助, 请通过查看并注册免费试用来帮助支持�
## 简介
-XMake是一个基于Lua的轻量级跨平台自动构建工具,支持在各种主流平台上构建项目
+xmake 是一个基于 Lua 的轻量级跨平台构建工具,使用 xmake.lua 维护项目构建,相比 makefile/CMakeLists.txt,配置语法更加简洁直观,对新手非常友好,短时间内就能快速入门,能够让用户把更多的精力集中在实际的项目开发上。
-xmake的目标是开发者更加关注于项目本身开发,简化项目的描述和构建,并且提供平台无关性,使得一次编写,随处构建
+虽然,简单易用是 xmake 的一大特色,但 xmake 的功能也是非常强大的,既能够像 Make/Ninja 那样可以直接编译项目,也可以像 CMake/Meson 那样生成工程文件,还有内置的包管理系统来帮助用户解决 C/C++依赖库的集成使用问题。
-它跟cmake、automake、premake有点类似,但是机制不同,它默认不会去生成IDE相关的工程文件,采用直接编译,并且更加的方便易用
-采用lua的工程描述语法更简洁直观,支持在大部分常用平台上进行构建,以及交叉编译
-
-并且xmake提供了创建、配置、编译、打包、安装、卸载、运行等一些actions,使得开发和构建更加的方便和流程化。
-
-不仅如此,它还提供了许多更加高级的特性,例如插件扩展、脚本宏记录、批量打包、自动文档生成等等。。
+目前,xmake主要用于C/C++项目的构建,但是同时也支持其他native语言的构建,可以实现跟C/C++进行混合编译,同时编译速度也是非常的快,可以跟Ninja持平。
如果你想要了解更多,请参考:[在线文档](https://xmake.io/#/zh-cn/getting_started), [Github](https://github.com/xmake-io/xmake)以及[Gitee](https://gitee.com/tboox/xmake)