aboutsummaryrefslogtreecommitdiff
path: root/src/guide/introduction.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/guide/introduction.md')
-rw-r--r--src/guide/introduction.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/src/guide/introduction.md b/src/guide/introduction.md
new file mode 100644
index 00000000..9fc29529
--- /dev/null
+++ b/src/guide/introduction.md
@@ -0,0 +1,56 @@
+<p>
+<div align="center">
+ <a href="http://xmake.io">
+ <img width="200" heigth="200" src="http://tboox.org/static/img/xmake/logo256c.png">
+ </a>
+
+ <h1>xmake</h1>
+
+ <div>
+ <a href="https://travis-ci.org/tboox/xmake">
+ <img src="https://img.shields.io/travis/tboox/xmake/master.svg?style=flat-square" alt="travis-ci" />
+ </a>
+ <a href="https://ci.appveyor.com/project/waruqi/xmake/branch/master">
+ <img src="https://img.shields.io/appveyor/ci/waruqi/xmake/master.svg?style=flat-square" alt="appveyor-ci" />
+ </a>
+ <a href="https://codecov.io/gh/tboox/xmake">
+ <img src="https://img.shields.io/codecov/c/github/tboox/xmake/master.svg?style=flat-square" alt="Coverage" />
+ </a>
+ <a href="https://aur.archlinux.org/packages/xmake">
+ <img src="https://img.shields.io/aur/votes/xmake.svg?style=flat-square" alt="AUR votes" />
+ </a>
+ <a href="https://github.com/tboox/xmake/releases">
+ <img src="https://img.shields.io/github/release/tboox/xmake.svg?style=flat-square" alt="Github All Releases" />
+ </a>
+ </div>
+ <div>
+ <a href="https://github.com/tboox/xmake/blob/master/LICENSE.md">
+ <img src="https://img.shields.io/github/license/tboox/xmake.svg?colorB=f48041&style=flat-square" alt="license" />
+ </a>
+ <a href="https://www.reddit.com/r/tboox/">
+ <img src="https://img.shields.io/badge/chat-on%20reddit-ff3f34.svg?style=flat-square" alt="Reddit" />
+ </a>
+ <a href="https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">
+ <img src="https://img.shields.io/gitter/room/tboox/tboox.svg?style=flat-square&colorB=96c312" alt="Gitter" />
+ </a>
+ <a href="https://t.me/tbooxorg">
+ <img src="https://img.shields.io/badge/chat-on%20telegram-blue.svg?style=flat-square" alt="Telegram" />
+ </a>
+ <a href="https://jq.qq.com/?_wv=1027&k=5hpwWFv">
+ <img src="https://img.shields.io/badge/chat-on%20QQ-ff69b4.svg?style=flat-square" alt="QQ" />
+ </a>
+ <a href="http://xmake.io/pages/donation.html#donate">
+ <img src="https://img.shields.io/badge/donate-us-orange.svg?style=flat-square" alt="Donate" />
+ </a>
+ </div>
+
+ <p>A cross-platform build utility based on Lua</p>
+</div>
+</p>
+
+## Introduction
+
+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.