summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorruki <[email protected]>2017-05-13 22:08:38 +0800
committerruki <[email protected]>2017-05-13 22:08:38 +0800
commit053844fb769cfd75e351177134f45ba312aae566 (patch)
tree4903d707a2d1a3b9ca1234b5d2a89bc0530d737b
parent378e05540223f68900ab43b1995266e3dd1a59e3 (diff)
improve install documents
-rw-r--r--docs/README.md52
-rw-r--r--docs/cn/index.html14
-rw-r--r--docs/landing.html14
-rwxr-xr-xdocs/landing/index.cn.md14
-rwxr-xr-xdocs/landing/index.md14
-rwxr-xr-xdocs/zh/README.md39
6 files changed, 88 insertions, 59 deletions
diff --git a/docs/README.md b/docs/README.md
index 197a36c58..70ce5b868 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -15,48 +15,39 @@ so that any developer can quickly pick it up and enjoy the productivity boost wh
## Installation
-#### Windows
-
-1. Download xmake windows installer from [Releases](https://github.com/tboox/xmake/releases)
-2. Run xmake-[version].exe
+#### Master
-Or install master version in powershell:
+##### via curl
```bash
-$ Invoke-Expression (Invoke-Webrequest 'https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.ps1' -UseBasicParsing).Content
+$ bash <(curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh)
```
-#### MacOS
+##### via wget
```bash
-$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-$ brew install xmake
+$ bash <(wget https://github.com/tboox/xmake/raw/master/scripts/get.sh -O -)
```
-Or
-
-1. Download xmake `.pkg` install package from [Releases](https://github.com/tboox/xmake/releases)
-2. Run it
-
-Or install master version:
+##### via powershell
```bash
-# use homebrew
-$ brew install xmake --HEAD
-
-# or download install directly
-$ bash <(curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh)
+$ Invoke-Expression (Invoke-Webrequest 'https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.ps1' -UseBasicParsing).Content
```
-#### Linux
+#### Windows
-Using Linuxbrew:
+1. Download xmake windows installer from [Releases](https://github.com/tboox/xmake/releases)
+2. Run xmake-[version].exe
+
+#### MacOS
```bash
-$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/linuxbrew/go/install)"
$ brew install xmake
```
+#### Linux
+
On Archlinux:
```bash
@@ -90,21 +81,6 @@ Or download deb package to install it:
1. Download xmake `.deb` install package from [Releases](https://github.com/tboox/xmake/releases)
2. Run `dpkg -i xmake-xxxx.deb`
-On Redhat/Centos:
-
-1. Download xmake `.rpm` install package from [Releases](https://github.com/tboox/xmake/releases)
-2. Run `yum install xmake-xxx.rpm --nogpgcheck`
-
-Or install master version:
-
-```bash
-# use linuebrew
-$ brew install xmake --HEAD
-
-# or download install directly
-$ bash <(curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh)
-```
-
#### Compilation
```bash
diff --git a/docs/cn/index.html b/docs/cn/index.html
index 6fbff04b1..9d2af3559 100644
--- a/docs/cn/index.html
+++ b/docs/cn/index.html
@@ -51,10 +51,24 @@
<h2 id="section">安装</h2>
+<h4 id="curl">使用curl</h4>
+
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>bash &lt;<span class="o">(</span>curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh<span class="o">)</span>
</code></pre>
</div>
+<h4 id="wget">使用wget</h4>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>bash &lt;<span class="o">(</span>wget https://github.com/tboox/xmake/raw/master/scripts/get.sh -O -<span class="o">)</span>
+</code></pre>
+</div>
+
+<h4 id="powershell">使用powershell</h4>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>Invoke-Expression <span class="o">(</span>Invoke-Webrequest <span class="s1">'https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.ps1'</span> -UseBasicParsing<span class="o">)</span>.Content
+</code></pre>
+</div>
+
<h2 id="section-1">简单的工程描述</h2>
<div class="language-lua highlighter-rouge"><pre class="highlight"><code><span class="n">target</span><span class="p">(</span><span class="s2">"console"</span><span class="p">)</span>
diff --git a/docs/landing.html b/docs/landing.html
index 98eeaee5d..fea69a092 100644
--- a/docs/landing.html
+++ b/docs/landing.html
@@ -51,10 +51,24 @@
<h2 id="installation">Installation</h2>
+<h4 id="via-curl">via curl</h4>
+
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>bash &lt;<span class="o">(</span>curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh<span class="o">)</span>
</code></pre>
</div>
+<h4 id="via-wget">via wget</h4>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>bash &lt;<span class="o">(</span>wget https://github.com/tboox/xmake/raw/master/scripts/get.sh -O -<span class="o">)</span>
+</code></pre>
+</div>
+
+<h4 id="via-powershell">via powershell</h4>
+
+<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>Invoke-Expression <span class="o">(</span>Invoke-Webrequest <span class="s1">'https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.ps1'</span> -UseBasicParsing<span class="o">)</span>.Content
+</code></pre>
+</div>
+
<h2 id="simple-description">Simple description</h2>
<div class="language-lua highlighter-rouge"><pre class="highlight"><code><span class="n">target</span><span class="p">(</span><span class="s2">"console"</span><span class="p">)</span>
diff --git a/docs/landing/index.cn.md b/docs/landing/index.cn.md
index b53a46d31..bd0ed23c4 100755
--- a/docs/landing/index.cn.md
+++ b/docs/landing/index.cn.md
@@ -5,10 +5,24 @@ title: {{ site.name }}
## 安装
+#### 使用curl
+
```bash
$ bash <(curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh)
```
+#### 使用wget
+
+```bash
+$ bash <(wget https://github.com/tboox/xmake/raw/master/scripts/get.sh -O -)
+```
+
+#### 使用powershell
+
+```bash
+$ Invoke-Expression (Invoke-Webrequest 'https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.ps1' -UseBasicParsing).Content
+```
+
## 简单的工程描述
```lua
diff --git a/docs/landing/index.md b/docs/landing/index.md
index b2b49aa50..1005a1ef9 100755
--- a/docs/landing/index.md
+++ b/docs/landing/index.md
@@ -5,10 +5,24 @@ title: {{ site.name }}
## Installation
+#### via curl
+
```bash
$ bash <(curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh)
```
+#### via wget
+
+```bash
+$ bash <(wget https://github.com/tboox/xmake/raw/master/scripts/get.sh -O -)
+```
+
+#### via powershell
+
+```bash
+$ Invoke-Expression (Invoke-Webrequest 'https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.ps1' -UseBasicParsing).Content
+```
+
## Simple description
```lua
diff --git a/docs/zh/README.md b/docs/zh/README.md
index 7fec9e79e..c0dfbe948 100755
--- a/docs/zh/README.md
+++ b/docs/zh/README.md
@@ -22,17 +22,31 @@ xmake的目标是开发者更加关注于项目本身开发,简化项目的描
## 安装
-#### Windows
+#### Master版本
-1. 从 [Releases](https://github.com/tboox/xmake/releases) 上下载windows安装包
-2. 运行安装程序 xmake-[version].exe
+##### 使用curl
+
+```bash
+$ bash <(curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh)
+```
-或者在powershell中安装master版本:
+##### 使用wget
+
+```bash
+$ bash <(wget https://github.com/tboox/xmake/raw/master/scripts/get.sh -O -)
+```
+
+##### 使用powershell
```bash
$ Invoke-Expression (Invoke-Webrequest 'https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.ps1' -UseBasicParsing).Content
```
+#### Windows
+
+1. 从 [Releases](https://github.com/tboox/xmake/releases) 上下载windows安装包
+2. 运行安装程序 xmake-[version].exe
+
#### MacOS
```bash
@@ -57,13 +71,6 @@ $ bash <(curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts
#### Linux
-使用linuxbrew安装:
-
-```bash
-$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/linuxbrew/go/install)"
-$ brew install xmake
-```
-
在archlinux上安装:
```bash
@@ -102,16 +109,6 @@ $ sudo apt-get install xmake
1. 从 [Releases](https://github.com/tboox/xmake/releases) 上下载rpm安装包
2. 运行: `yum install xmake-xxx.rpm --nogpgcheck`
-或者安装master版本:
-
-```bash
-# 使用linuxbrew安装master版本
-$ brew install xmake --HEAD
-
-# 或者直接调用shell下载安装
-$ bash <(curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh)
-```
-
#### 编译安装
```bash