Skip to content

Commit 84fa20c

Browse files
committed
add chinese README
1 parent 11a733f commit 84fa20c

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,56 @@ features
3737
9. custom platforms and toolchains
3838
10. custom rules for package/compiler/linker
3939

40+
## 简介
41+
42+
XMake是一个跨平台自动构建工具,支持在各种主流平台上构建项目,类似cmake、automake、premake,但是更加的方便易用,工程描述语法更简洁直观,支持平台更多,并且集创建、配置、编译、打包、安装、卸载、运行于一体。
43+
44+
* [在线文档](https://github.com/waruqi/xmake/wiki/%E7%9B%AE%E5%BD%95)
45+
* [在线源码](https://github.com/waruqi/xmake)
46+
47+
#### 支持特性
48+
49+
1. 支持windows、mac、linux、ios、android等平台,自动检测不同平台上的编译工具链(也可手动配置)
50+
编译windows项目采用原生vs的工具链,不需要使用cygwin、mingw(当然这些也支持)
51+
52+
2. 支持自定义平台编译配置,可以很方便的扩展第三方平台支持
53+
54+
3. 采用lua脚本语法描述项目,描述规则简单高效,逻辑规则可灵活修改,并且不会生成相关平台的工程文件,是工程更加简单明了
55+
56+
4. 支持创建模板工程、配置项目、编译项目、运行、打包、安装和卸载等常用功能(后续还会增加:自动生成文档、调试等模块)
57+
58+
5. 支持编译c/c++/objc成静态库、动态库、命令行可执行程序(后续还会增加:mac、ios、android的app的生成规则)
59+
60+
6. 提供丰富的工程描述api,使用简单灵活,例如添加编译文件只需(还支持过滤排除):
61+
62+
`add_files("src/*.c", "src/asm/**.S", "src/*.m")`
63+
64+
7. 支持头文件、接口、链接库依赖、类型的自动检测,并可自动生成配置头文件config.h
65+
66+
8. 支持自定义编译配置开关,例如如果在工程描述文件中增加了enable_xxx的开关,那么配置编译的时候就可以手动进行配置来启用它:
67+
68+
`xmake config --enable_xxx=true`
69+
70+
9. 提供一键打包功能,不管在哪个平台上进行打包,都只需要执行一条相同的命令,非常的方便
71+
72+
10. 支持自定义编译工具和规则,例如想要增加对masm/yasm的编译规则,只需将自己写的masm.lua/yasm.lua规则文件,放到当前项目目录下即可。。
73+
74+
11. 支持全局配置,一些常用的项目配置,例如工具链、规则描述等等,都可以进行全局配置,这样就不需要每次编译不同工程,都去配置一遍
75+
76+
12. 除了可以自动检测依赖模块,也支持手动强制配置模块,还有各种编译flags。
77+
78+
也可以参考使用xmake的实际项目:[TBOX](https://github.com/waruqi/tbox)
79+
80+
####后续工作
81+
82+
1. 完善打包模块,支持对ios、mac、android的app进行一键打包和签名,生成.ipa、.apk、.app的应用程序文件
83+
2. 完善安装功能,支持对ios、android的app进行安装到设备
84+
3. 实现调试功能
85+
4. 实现自动生成doxygen文档功能
86+
5. 增加一些实用的工程描述api,例如:下载api,可以自动下载缺少的依赖库等等。。
87+
6. 解析automake、cmake的工程,并自动生成xmake的描述文件,实现无缝编译(如果这个实现成功的话,以后移植编译一些开源代码就更方便了)
88+
89+
4090
contact
4191
-------
4292

0 commit comments

Comments
 (0)