From 4058f49432cd95263b8880960ab356bc8bcd96d0 Mon Sep 17 00:00:00 2001 From: ruki Date: Tue, 4 Jul 2017 21:26:05 +0800 Subject: modify readme and docs --- .github/ISSUE_TEMPLATE.md | 2 -- CONTRIBUTING.md | 58 ++++++++++++++++++++++++--------------- README.md | 10 +------ README_zh.md | 24 +++++++++++++++- docs/README.md | 23 ++++++++++++++++ docs/cn/pages/donation.html | 17 ++++++++++++ docs/landing/pages/donation.cn.md | 19 +++++++++++++ docs/landing/pages/donation.md | 23 ++++++++++++++-- docs/pages/donation.html | 33 ++++++++++++++++------ docs/zh/README.md | 23 ++++++++++++++++ 10 files changed, 188 insertions(+), 44 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index d018d7733..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,2 +0,0 @@ - \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d58a9de68..384fc6385 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,6 +39,34 @@ try to follow these guidelines when you do so. For example, to copy a directory in sandbox, calling link is: `sandbox_os.cp()` -> `os.cp()` -> `xm_os_cpdir()` -> `tb_directory_copy()` +## Financial contributions + +We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/xmake). +Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed. + +## Credits + +### Backers + +Thank you to all our backers! [[Become a backer](https://opencollective.com/xmake#backer)] + + + +### Sponsors + +Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/xmake#sponsor)) + + + + + + + + + + + + # 贡献代码 如果你发现一些问题，或者想新增或者改进某些新特性，或者想贡献一个新的模块 @@ -62,32 +90,15 @@ For example, to copy a directory in sandbox, calling link is: `sandbox_os.cp()` [1]: https://github.com/tboox/xmake/issues +## 支持项目 -## Financial contributions - -We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/xmake). -Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed. - - -## Credits - - -### Contributors - -Thank you to all the people who have already contributed to xmake! - - - -### Backers - -Thank you to all our backers! [[Become a backer](https://opencollective.com/xmake#backer)] +xmake项目属于个人开源项目，它的发展需要您的帮助，如果您愿意支持xmake项目的开发，欢迎为其捐赠，支持它的发展。 🙏 [[支持此项目](https://opencollective.com/xmake#backer)] +## 赞助项目 -### Sponsors - -Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/xmake#sponsor)) +通过赞助支持此项目，您的logo和网站链接将显示在这里。[[赞助此项目](https://opencollective.com/xmake#sponsor)] @@ -98,4 +109,7 @@ Thank you to all our sponsors! (please ask your company to also support this ope - \ No newline at end of file + + + + diff --git a/README.md b/README.md index ba3583643..e0948e9f0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # A make-like build utility based on Lua -[![Backers on Open Collective](https://opencollective.com/xmake/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/xmake/sponsors/badge.svg)](#sponsors) [![Build Status](https://api.travis-ci.org/tboox/xmake.svg?branch=master)](https://travis-ci.org/tboox/xmake) [![Build status](https://ci.appveyor.com/api/projects/status/ry9oa2mxrj8hk613/branch/master?svg=true)](https://ci.appveyor.com/project/waruqi/xmake/branch/master) [![codecov](https://codecov.io/gh/tboox/xmake/branch/master/graph/badge.svg)](https://codecov.io/gh/tboox/xmake) [![Join the chat at https://gitter.im/tboox/tboox](https://badges.gitter.im/tboox/tboox.svg)](https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![donate](http://tboox.org/static/img/donate.svg)](http://xmake.io/pages/donation.html#donate) +[![Build Status](https://api.travis-ci.org/tboox/xmake.svg?branch=master)](https://travis-ci.org/tboox/xmake) [![Build status](https://ci.appveyor.com/api/projects/status/ry9oa2mxrj8hk613/branch/master?svg=true)](https://ci.appveyor.com/project/waruqi/xmake/branch/master) [![codecov](https://codecov.io/gh/tboox/xmake/branch/master/graph/badge.svg)](https://codecov.io/gh/tboox/xmake) [![Join the chat at https://gitter.im/tboox/tboox](https://badges.gitter.im/tboox/tboox.svg)](https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![donate](http://tboox.org/static/img/donate.svg)](http://xmake.io/pages/donation.html#donate) [![Backers on Open Collective](https://opencollective.com/xmake/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/xmake/sponsors/badge.svg)](#sponsors) [![logo](http://tboox.org/static/img/xmake/logo256.png)](http://xmake.io) @@ -256,20 +256,12 @@ Some projects using xmake: * Homepage：[tboox.org](http://www.tboox.org) * Community：[tboox@community](https://github.com/tboox/community/issues) - -## Contributors - -This project exists thanks to all the people who contribute. [[Contribute]](CONTRIBUTING.md). - - - ## Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/xmake#backer)] - ## Sponsors Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/xmake#sponsor)] diff --git a/README_zh.md b/README_zh.md index 22751ae0f..337eb396a 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,6 +1,6 @@ # 一个基于Lua的轻量级跨平台自动构建工具 -[![Build Status](https://api.travis-ci.org/tboox/xmake.svg?branch=master)](https://travis-ci.org/tboox/xmake) [![Build status](https://ci.appveyor.com/api/projects/status/ry9oa2mxrj8hk613/branch/master?svg=true)](https://ci.appveyor.com/project/waruqi/xmake/branch/master) [![codecov](https://codecov.io/gh/tboox/xmake/branch/master/graph/badge.svg)](https://codecov.io/gh/tboox/xmake) [![Join the chat at https://gitter.im/tboox/tboox](https://badges.gitter.im/tboox/tboox.svg)](https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![donate](http://tboox.org/static/img/donate.svg)](http://xmake.io/cn/pages/donation.html#donate) +[![Build Status](https://api.travis-ci.org/tboox/xmake.svg?branch=master)](https://travis-ci.org/tboox/xmake) [![Build status](https://ci.appveyor.com/api/projects/status/ry9oa2mxrj8hk613/branch/master?svg=true)](https://ci.appveyor.com/project/waruqi/xmake/branch/master) [![codecov](https://codecov.io/gh/tboox/xmake/branch/master/graph/badge.svg)](https://codecov.io/gh/tboox/xmake) [![Join the chat at https://gitter.im/tboox/tboox](https://badges.gitter.im/tboox/tboox.svg)](https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![donate](http://tboox.org/static/img/donate.svg)](http://xmake.io/pages/donation.html#donate) [![Backers on Open Collective](https://opencollective.com/xmake/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/xmake/sponsors/badge.svg)](#sponsors) [![logo](http://tboox.org/static/img/xmake/logo256.png)](http://xmake.io/cn) @@ -255,3 +255,25 @@ target("test") * QQ群：343118190 * 微信公众号：tboox-os +## 支持项目 + +xmake项目属于个人开源项目，它的发展需要您的帮助，如果您愿意支持xmake项目的开发，欢迎为其捐赠，支持它的发展。 🙏 [[支持此项目](https://opencollective.com/xmake#backer)] + + + +## 赞助项目 + +通过赞助支持此项目，您的logo和网站链接将显示在这里。[[赞助此项目](https://opencollective.com/xmake#sponsor)] + + + + + + + + + + + + + diff --git a/docs/README.md b/docs/README.md index 1b148d6ae..e665522be 100644 --- a/docs/README.md +++ b/docs/README.md @@ -526,3 +526,26 @@ And add `--backtrace` to get the verbose backtrace info, then you can submit the ```bash $ xmake -v --backtrace ``` + +## Backers + +Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/xmake#backer)] + + + +## Sponsors + +Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/xmake#sponsor)] + + + + + + + + + + + + + diff --git a/docs/cn/pages/donation.html b/docs/cn/pages/donation.html index 5b2609bee..05ddca97b 100644 --- a/docs/cn/pages/donation.html +++ b/docs/cn/pages/donation.html @@ -69,6 +69,8 @@

支持者

+

+ @@ -80,6 +82,21 @@
+

赞助者

+ +

通过赞助支持此项目，您的logo和网站链接将显示在这里。[赞助此项目]

+ +

+ + + + + + + + +

+