summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorruki <[email protected]>2016-01-01 13:14:04 +0800
committerruki <[email protected]>2016-01-01 13:14:04 +0800
commit12d6f6540be60c1f8dbf3d1857bd3149c63af0b3 (patch)
tree7a4702a9abac97d538af86186a3ce9b57f2d7896
parent596aaf95473b7e511edec03b49f96e4826305a14 (diff)
modify README
-rwxr-xr-xREADME.md90
1 files changed, 49 insertions, 41 deletions
diff --git a/README.md b/README.md
index 193ec06dc..28f70517d 100755
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
The Automatic Cross-platform Build Tool
========================
-Xmake is an automatic cross-platform build tool.
+xmake is an automatic cross-platform build tool.
It is similar to cmake, automake, premake, but more convenient and easy to use.
@@ -14,15 +14,14 @@ features
4. build and rebuild project
5. clean generated target files
6. package the project targets automatically
- - *.ipa for ios
- - *.apk for android
+ - *.ipa for ios(feature)
+ - *.apk for android(feature)
- *.pkg for library
- - *.app for macosx
+ - *.app for macosx(feature)
- *.exe for windows
- others
-
-7. install target to pc or the mobile device
+7. install target
8. run a given target
9. describe the project file using lua script, more flexible and simple
```lua
@@ -39,6 +38,16 @@ features
10. custom platforms and toolchains
11. custom rules for package/compiler/linker
+projects
+--------
+
+some projects using xmake:
+
+* [tbox](https://github.com/waruqi/tbox)
+* [gbox](https://github.com/waruqi/gbox)
+* [more](https://github.com/waruqi/xmake/wiki/%E4%BD%BF%E7%94%A8xmake%E7%9A%84%E5%BC%80%E6%BA%90%E5%BA%93)
+
+
## 简介
XMake是一个跨平台自动构建工具,支持在各种主流平台上构建项目,类似cmake、automake、premake,但是更加的方便易用,工程描述语法更简洁直观,支持平台更多,并且集创建、配置、编译、打包、安装、卸载、运行于一体。
@@ -92,41 +101,6 @@ XMake是一个跨平台自动构建工具,支持在各种主流平台上构建
5. 增加一些实用的工程描述api,例如:下载api,可以自动下载缺少的依赖库等等。。
6. 解析automake、cmake的工程,并自动生成xmake的描述文件,实现无缝编译(如果这个实现成功的话,以后移植编译一些开源代码就更方便了)
-
-contact
--------
-
-- email:
-- source:
- - [github](https://github.com/waruqi/xmake)
- - [coding](https://coding.net/u/waruqi/p/xmake/git)
- - [oschina](http://git.oschina.net/tboox/xmake)
-- website:
- - http://www.tboox.org
- - http://www.tboox.net
-- download:
- - [github](https://github.com/waruqi/xmake/archive/master.zip)
- - [coding](https://coding.net/u/waruqi/p/xmake/git/archive/master)
- - [oschina](http://git.oschina.net/tboox/xmake/repository/archive?ref=master)
-- document:
- - [github](https://github.com/waruqi/xmake/wiki/)
- - [oschina](http://git.oschina.net/tboox/xmake/wikis/home)
-- qq(group):
- - 343118190
-
-donate
-------
-
-####alipay
-<img src="http://www.tboox.net/ruki/alipay.png" alt="alipay" width="128" height="128">
-
-####paypal
-<a href="http://tboox.net/%E6%8D%90%E5%8A%A9/">
-<img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" alt="paypal">
-</a>
-
install
-------
@@ -246,3 +220,37 @@ add_target("test")
add_files("src/*.c")
```
+
+contact
+-------
+
+- email:
+- source:
+ - [github](https://github.com/waruqi/xmake)
+ - [coding](https://coding.net/u/waruqi/p/xmake/git)
+ - [oschina](http://git.oschina.net/tboox/xmake)
+- website:
+ - http://www.tboox.org
+ - http://www.tboox.net
+- download:
+ - [github](https://github.com/waruqi/xmake/archive/master.zip)
+ - [coding](https://coding.net/u/waruqi/p/xmake/git/archive/master)
+ - [oschina](http://git.oschina.net/tboox/xmake/repository/archive?ref=master)
+- document:
+ - [github](https://github.com/waruqi/xmake/wiki/)
+ - [oschina](http://git.oschina.net/tboox/xmake/wikis/home)
+- qq(group):
+ - 343118190
+
+donate
+------
+
+####alipay
+<img src="http://www.tboox.net/ruki/alipay.png" alt="alipay" width="128" height="128">
+
+####paypal
+<a href="http://tboox.net/%E6%8D%90%E5%8A%A9/">
+<img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" alt="paypal">
+</a>