From de636b123afe991cde86d6ecef7aa6494cf959c2 Mon Sep 17 00:00:00 2001
From: V2Ray <admin@v2ray.com>
Date: Sat, 12 Sep 2015 22:56:45 +0200
Subject: [PATCH] install method

---
 README.md                                |  3 +++
 release/config/in_socks.json             |  3 ++-
 release/config/in_vmess.json             |  2 ++
 release/config/out_vmess.json            |  4 +++-
 release/config/vpoint_socks_vmess.json   |  7 +++---
 release/config/vpoint_vmess_freedom.json |  1 +
 spec/install.md                          | 28 ++++++++++++++++++++++++
 7 files changed, 43 insertions(+), 5 deletions(-)
 create mode 100644 spec/install.md

diff --git a/README.md b/README.md
index 8d15681f8..f0bbb90c9 100644
--- a/README.md
+++ b/README.md
@@ -25,5 +25,8 @@ V2Ray 是一个翻墙工具包，用于简化和复用其它翻墙工具，加
 * 2016.01 **1.5** 完成，兼容 ShadowSocks 协议
 * 2016.04 **2.0** 完成，多服务器模式
 
+## 进展
+Version 1.0 Alpha，[安装方式](https://github.com/V2Ray/v2ray-core/blob/master/spec/install.md)。理论上可用，简单测试通过，还未进行稳定性和性能测试。
+
 ## 关于
 我是只是一名普通的开发人员，已肉翻，本已不依赖这些翻墙工具，但 ShadowSock 和 GoAgent 被迫删除代码的事件实在太恶心，不得不做点什么了。
\ No newline at end of file
diff --git a/release/config/in_socks.json b/release/config/in_socks.json
index 06cb86b0e..f789d4a94 100644
--- a/release/config/in_socks.json
+++ b/release/config/in_socks.json
@@ -1,3 +1,4 @@
+/* Socks 5 协议配置 */
 {
-  "auth": "noauth"
+  "auth": "noauth" /* 用户验证方式，暂时只支持匿名模式 */
 }
diff --git a/release/config/in_vmess.json b/release/config/in_vmess.json
index 5df3150db..76e4e6a82 100644
--- a/release/config/in_vmess.json
+++ b/release/config/in_vmess.json
@@ -1,5 +1,7 @@
+/* VMess 接收配置 */
 {
   "clients": [
+    /* 允许的用户 ID */
     {"id": "ad937d9d-6e23-4a5a-ba23-bce5092a7c51"}
   ]
 }
diff --git a/release/config/out_vmess.json b/release/config/out_vmess.json
index 4675cc8ee..49a9e5cef 100644
--- a/release/config/out_vmess.json
+++ b/release/config/out_vmess.json
@@ -1,9 +1,11 @@
+/* VMess 转发配置 */
 {
   "vnext": [
     {
-      "address": "127.0.0.1",
+      "address": "127.0.0.1", /* 中继服务器地址 */
       "port": 27183,
       "users": [
+        /* 以下列用户身份转发 */
         {"id": "ad937d9d-6e23-4a5a-ba23-bce5092a7c51"}
       ]
     }
diff --git a/release/config/vpoint_socks_vmess.json b/release/config/vpoint_socks_vmess.json
index db43a157e..4287128f5 100644
--- a/release/config/vpoint_socks_vmess.json
+++ b/release/config/vpoint_socks_vmess.json
@@ -1,11 +1,12 @@
+/* Point 服务器配置，接受 Socks5 协议请求，并转发到一下 Point 服务器。 */
 {
-  "port": 1080,
+  "port": 1080, /* Socks 5 端口 */
   "inbound": {
     "protocol": "socks",
-    "file": "in_socks.json"
+    "file": "in_socks.json" /* Socks 5 配置文件 */
   },
   "outbound": {
     "protocol": "vmess",
-    "file": "out_vmess.json"
+    "file": "out_vmess.json" /* VMess 配置文件 */
   }
 }
diff --git a/release/config/vpoint_vmess_freedom.json b/release/config/vpoint_vmess_freedom.json
index af5992cb8..38a5865d6 100644
--- a/release/config/vpoint_vmess_freedom.json
+++ b/release/config/vpoint_vmess_freedom.json
@@ -1,3 +1,4 @@
+/* Point 服务器配置，输入 VMess 协议，转发到最终要该问的网站。 */
 {
   "port": 27183,
   "inbound": {
diff --git a/spec/install.md b/spec/install.md
new file mode 100644
index 000000000..624911626
--- /dev/null
+++ b/spec/install.md
@@ -0,0 +1,28 @@
+# V2Ray 安装方式
+
+目前 V2Ray 还在早期测试阶段，暂不提供预编译的运行文件。请使用下面的方式下载源文件并编译。
+
+## 编译源文件
+1. 安装 Git： sudo apt-get install git -y
+2. 安装 golang：
+  1. curl -o go_latest.tar.gz https://storage.googleapis.com/golang/go1.5.1.linux-amd64.tar.gz
+  2. sudo tar -C /usr/local -xzf go_latest.tar.gz
+3. export PATH=$PATH:/usr/local/go/bin
+4. export GOPATH=$HOME/work
+5. go get github.com/v2ray/v2ray-core
+6. go build github.com/v2ray/v2ray-core/release/server
+
+## 运行
+
+Socks 5 转发 VMess：
+
+./server --config=$HOME/work/src/github.com/v2ray/v2ray-core/release/config/vpoint_socks_vmess.json
+
+VMess 转发最终网站：
+
+./server --config=$HOME/work/src/github.com/v2ray/v2ray-core/release/config/vpoint_vmess_freedom.json
+
+测试服务器可用性：
+
+curl -v --socks5-hostname 127.0.0.1:1080 https://www.google.com/
+