文档

2014-09-13 17:19:28 +08:00 · 2014-09-13 17:19:28 +08:00 · 1be309b08a
parent 09c7ba6d9a
commit 1be309b08a
5 changed files with 35 additions and 6 deletions
--- a/conf/wide.go
+++ b/conf/wide.go
@ -27,8 +27,6 @@ type conf struct {
 	OutputChannel         string
 	ShellChannel          string
 	StaticResourceVersion string
-	ContextPath           string
-	StaticPath            string
 	MaxProcs              int
 	RuntimeMode           string
 	Pwd                   string
--- a/conf/wide.json
+++ b/conf/wide.json
@ -5,8 +5,6 @@
    "OutputChannel": "ws://{IP}:7070",
    "ShellChannel": "ws://{IP}:7070",
    "StaticResourceVersion": "201409032040",
-    "ContextPath": "",
-    "StaticPath": "",
    "MaxProcs": 4,
    "RuntimeMode": "dev",
    "Pwd": "{pwd}",
--- a/doc/zh_CN/conf.html
+++ b/doc/zh_CN/conf.html
@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="UTF-8">
+        <title>Wide - 配置</title>
+
+    </head>
+    <body>
+        <h1>配置</h1>
+
+        <pre>
+{
+    "Server": "{IP}:7070", 运行的 IP，端口   
+    "StaticServer": "http://{IP}:7070", 静态资源服务 IP，端口
+    "EditorChannel": "ws://{IP}:7070", 编辑器消息通道
+    "OutputChannel": "ws://{IP}:7070", 输出窗口消息通道
+    "ShellChannel": "ws://{IP}:7070", Shell 消息通道
+    "StaticResourceVersion": "201409032040", 静态资源版本    
+    "MaxProcs": 4, Go 协程并行处理数量，可等于 Go CPU 核数
+    "RuntimeMode": "dev", 运行模式，dev 为开发模式，prod 为生产模式
+    "Pwd": "{pwd}", 工作目录，设置为 "{pwd}" 将自动获取
+    "Users": [
+        {
+            "Name": "admin", 用户名
+            "Password": "admin", 用户密码
+            "Workspace": "{Pwd}/data/user_workspaces/admin" 用户工作空间（GOPATH）
+        }
+    ]
+}
+        </pre>
+    </body>
+</html>
--- a/doc/zh_CN/index.html
+++ b/doc/zh_CN/index.html
@ -29,6 +29,7 @@

        <h2>使用指南</h2>
        <ul>            
+            <li><a href="setup.html">安装</a></li>
            <li><a href="multiplayer.html">多用户</a></li>
            <li><a href="editor.html">编辑器</a></li>
            <li><a href="keyboard_shortcuts.html">键盘快捷键</a></li>
--- a/doc/zh_CN/setup.html
+++ b/doc/zh_CN/setup.html
@ -8,11 +8,11 @@
    <body>
        <h1>安装</h1>

-        <h2>基础配置</h2>
+        <h2>基础安装</h2>
        <ol>
            <li>下载 Wide 安装包</li>
            <li>解压到安装路径 {wide}，例如 /root/wide</li>
-            <li>配置 {wide}/conf/wide.json</li>
+            <li>配置 {wide}/conf/wide.json（<a href="conf.html">配置项说明</a>）</li>
        </ol>   

        <h2>多用户配置</h2>