📝 README 使用中文
This commit is contained in:
Liang Ding
parent
e23e26dbdf
commit
36f0921c55
214
README.md
214
README.md
|
|
@ -1,171 +1,135 @@
|
|||
# [Wide](https://github.com/b3log/wide) [](https://travis-ci.org/b3log/wide) [](https://goreportcard.com/report/github.com/b3log/wide) [](https://coveralls.io/r/b3log/wide) [](https://www.apache.org/licenses/LICENSE-2.0) [](https://godoc.org/github.com/b3log/wide) [](https://pan.baidu.com/s/1dD3XwOT)
|
||||
|
||||
_Have a [try](https://wide.b3log.org/signup) first, then [download](https://pan.baidu.com/s/1dD3XwOT) and setup it on your local area network, enjoy yourself!_
|
||||
|
||||
先试试我们搭建好的[在线服务](https://wide.b3log.org/signup)，你可以在这里[下载](https://pan.baidu.com/s/1dD3XwOT)并在本地环境运行，然后邀请小伙伴们来玩吧！
|
||||
|
||||
> * 关于 Wide 的产品定位，请看[这里](https://hacpai.com/article/1438407961481)，并欢迎参与讨论~
|
||||
> * 加入[**黑客派**](https://hacpai.com/register)，与其他程序员、设计师共同成长！
|
||||
## 简介
|
||||
|
||||
## Introduction
|
||||
Wide 是一个基于 **W**eb 的 Go 语言 **IDE**。
|
||||
|
||||
A <b>W</b>eb-based <b>IDE</b> for Teams using Go programming language/Golang.
|
||||
|
||||
|
||||
|
||||
## 动机
|
||||
|
||||
## Authors
|
||||
目前较为流行的 Go IDE 都有一些缺陷或遗憾：
|
||||
* 文本编辑器类（vim/emacs/sublime/Atom 等）：对于新手门槛太高，搭建复杂
|
||||
* 插件类（goclipse、IDEA 等）：需要原 IDE 支持，不够专业
|
||||
* LiteIDE 界面不够 modern、goland 收费
|
||||
* **缺少网络分享、嵌入网站可运行功能**
|
||||
|
||||
[Daniel](https://github.com/88250) and [Vanessa](https://github.com/Vanessa219) are the main authors of Wide, [here](https://github.com/b3log/wide/graphs/contributors) are all contributors.
|
||||
另外，Go IDE 很少，用 Go 本身开发的 IDE 更是没有，这是一个很好的尝试。关于产品定位的讨论请看[这里](https://hacpai.com/article/1438407961481)。
|
||||
|
||||
Wide 的主要作者是 [Daniel](https://github.com/88250) 与 [Vanessa](https://github.com/Vanessa219)，所有贡献者可以在[这里](https://github.com/b3log/wide/graphs/contributors)看到。
|
||||
## 特性
|
||||
|
||||
## Motivation
|
||||
基于 Web 的 IDE：
|
||||
|
||||
* **Team** IDE:
|
||||
* _Safe and reliable_: the project source code stored on the server in real time, the developer's machine crashes without losing any source code
|
||||
* _Unified environment_: server unified development environment configuration, the developer machine without any additional configuration
|
||||
* _Out of the box_: 5 minutes to setup a server then open browser to develop, debug
|
||||
* _Version Control_: each developer has its own source code repository, easy sync with the trunk
|
||||
* **Web-based** IDE:
|
||||
* Developer needs a browser only
|
||||
* Cross-platform, even on mobile devices
|
||||
* Easy to extend
|
||||
* Easy to integrate with other systems
|
||||
* For the geeks
|
||||
* A try for commercial-open source: versions customized for enterprises, close to their development work flows respectively
|
||||
* Currently more popular Go IDE has some defects or regrets:
|
||||
* Text editor (vim/emacs/sublime/Atom, etc.): For the Go newbie is too complex
|
||||
* Plug-in (goclipse, etc.): the need for the original IDE support, not professional
|
||||
* LiteIDE: no modern user interface :p
|
||||
* No team development experience
|
||||
* There are a few of GO IDEs, and no one developed by Go itself, this is a nice try
|
||||
* 只需要浏览器就能进行开发、运行
|
||||
* 跨平台，甚至在移动设备上
|
||||
* 易进行功能扩展
|
||||
* 易与其他系统集成
|
||||
* 极客体验
|
||||
|
||||
## Features
|
||||
核心功能：
|
||||
|
||||
* [X] Code Highlight, Folding: Go/HTML/JavaScript/Markdown etc.
|
||||
* [X] Autocomplete: Go/HTML etc.
|
||||
* [X] Format: Go/HTML/JSON etc.
|
||||
* [X] Build & Run
|
||||
* [X] Multiplayer: a real team development experience
|
||||
* [X] Navigation, Jump to declaration, Find usages, File search etc.
|
||||
* [X] Shell: run command on the server
|
||||
* [X] Web development: HTML/JS/CSS editor with [Emmet](https://emmet.io) integrated
|
||||
* [X] Go tool: go get/install/fmt etc.
|
||||
* [X] File Import & Export
|
||||
* [X] Themes: editor and UI adjust, respectively
|
||||
* [X] Cross-Compilation
|
||||
* [ ] Debug
|
||||
* [ ] Git integration: git command on the web
|
||||
* 代码高亮、折叠：Go/HTML/JavaScript/Markdown 等
|
||||
* 自动完成：Go/HTML 等
|
||||
* 编译检查：编辑器提示编译错误
|
||||
* 格式化：Go/HTML/JSON 等
|
||||
* 运行：支持同时运行多个程序，方便联调
|
||||
* 多用户：团队开发，方便协作
|
||||
* 代码导航：跳转到声明，查找使用，文件搜索等
|
||||
* Web 开发：前端（HTML/JS/CSS）开发支持
|
||||
* go tool：go get/install/fmt 等
|
||||
* 项目导入/导出
|
||||
* UI/编辑器多主题
|
||||
* 支持交叉编译
|
||||
* 调试：基于 gdb 的调试系统（TBD）
|
||||
* Git 整合：常用 git 命令可视化操作（TBD）
|
||||
* Shell：连接到服务器执行命令（TBD）
|
||||
|
||||
## Screenshots
|
||||
## 界面
|
||||
|
||||
* **Overview**
|
||||
### 主界面
|
||||
|
||||
|
||||
* **Goto File**
|
||||
|
||||
|
||||
|
||||
* **Autocomplete**
|
||||
### 跳转到文件
|
||||
|
||||
|
||||
* **Theme**
|
||||
|
||||
|
||||
|
||||
* **Show Expression Info**
|
||||
### 自动完成
|
||||
|
||||
|
||||
* **Build Error Info**
|
||||
|
||||
|
||||
|
||||
* **Git Clone**
|
||||
### 主题
|
||||
|
||||
|
||||
* **Cross-Compilation**
|
||||
|
||||
|
||||
|
||||
### 查看表达式
|
||||
|
||||
* **Playground**
|
||||
|
||||
|
||||
|
||||
## Architecture
|
||||
### 构建报错提示
|
||||
|
||||
### Build & Run
|
||||
|
||||
|
||||
### Git 克隆
|
||||
|
||||
|
||||
|
||||
### 交叉编译
|
||||
|
||||
|
||||
|
||||
### Playground
|
||||
|
||||
|
||||
|
||||
## 架构
|
||||
|
||||
### 构建与运行
|
||||
|
||||
|
||||
|
||||
* A browser tab corresponds to a Wide session
|
||||
* Execution output push via WebSocket
|
||||
* 一个浏览器 tab 对应一个 Wide 会话
|
||||
* 通过 WebSocket 进行程序执行输出推送
|
||||
|
||||
Flow:
|
||||
1. Browser sends ````Build```` request
|
||||
2. Server executes ````go build```` command via ````os/exec````<br/>
|
||||
2.1. Generates a executable file
|
||||
3. Browser sends ````Run```` request
|
||||
4. Server executes the file via ````os/exec````<br/>
|
||||
4.1. A running process<br/>
|
||||
4.2. Execution output push via WebSocket channel
|
||||
5. Browser renders with callback function ````ws.onmessage````
|
||||
1. 客户端浏览器发送 ````Build```` 请求
|
||||
2. 服务器使用 ````os/exec```` 执行 ````go build```` 命令<br/>
|
||||
2.1. 生成可执行文件
|
||||
3. 客户端浏览器发送 ````Run```` 请求
|
||||
4. 服务器使用 ````os/exec```` 执行文件<br/>
|
||||
4.1. 生成进程<br/>
|
||||
4.2. 运行结果输出到 WebSocket 通道
|
||||
5. 客户端浏览器监听 ````ws.onmessage```` 到消息后做展现
|
||||
|
||||
### Code Assist
|
||||
### 代码辅助
|
||||
|
||||
|
||||
|
||||
|
||||
* Autocompletion
|
||||
* Find Usages/Jump To Declaration/etc.
|
||||
* 自动完成
|
||||
* 查找使用
|
||||
|
||||
Flow:
|
||||
1. Browser sends code assist request
|
||||
2. Handler gets user workspace of the request with HTTP session
|
||||
3. Server executes ````gocode````/````ide_stub(gotools)````<br/>
|
||||
3.1 Sets environment variables (e.g. ${GOPATH})<br/>
|
||||
3.2 ````gocode```` with ````lib-path```` parameter
|
||||
1. 浏览器客户端发送代码辅助请求
|
||||
2. Handler 根据请求对应的 HTTP 会话获取用户工作空间
|
||||
3. 执行 `gocode`/`ide_stub(gotools)` 命令<br/>
|
||||
3.1 设置环境变量（${GOPATH} 为用户工作空间路径）<br/>
|
||||
3.2 `gocode` 命令需要设置参数 `lib-path`
|
||||
|
||||
## Documents
|
||||
## 文档
|
||||
|
||||
* [用户指南](https://hacpai.com/article/1538873544275)
|
||||
* [开发指南](https://www.gitbook.com/book/88250/wide-dev-guide)
|
||||
* [开发指南](https://hacpai.com/article/1538876422995)
|
||||
|
||||
## Setup
|
||||
## 社区
|
||||
|
||||
### Download Binary
|
||||
* [讨论区](https://hacpai.com/tag/wide)
|
||||
* [报告问题](https://github.com/b3log/wide/issues/new/choose)
|
||||
|
||||
We have provided OS-specific executable binary as follows:
|
||||
## 授权
|
||||
|
||||
* linux-amd64/386
|
||||
* windows-amd64/386
|
||||
* darwin-amd64/386
|
||||
Wide 使用 [Apache License, Version 2](https://www.apache.org/licenses/LICENSE-2.0) 作为开源协议，请务必遵循该开源协议相关约定。
|
||||
|
||||
Download [HERE](https://pan.baidu.com/s/1dD3XwOT)!
|
||||
|
||||
### Build Wide for yourself
|
||||
|
||||
1. [Download](https://github.com/b3log/wide/archive/master.zip) source or by `git clone https://github.com/b3log/wide`
|
||||
2. Get dependencies with
|
||||
* `go get`
|
||||
* `go get github.com/visualfc/gotools github.com/nsf/gocode github.com/bradfitz/goimports`
|
||||
3. Compile wide with `go build`
|
||||
|
||||
### Docker
|
||||
|
||||
1. Get image: `sudo docker pull 88250/wide:latest`
|
||||
2. Run: `sudo docker run -p 127.0.0.1:7070:7070 88250/wide:latest ./wide -docker=true -channel=ws://127.0.0.1:7070`
|
||||
3. Open browser: http://127.0.0.1:7070
|
||||
|
||||
## Known Issues
|
||||
|
||||
* [Shell is not available on Windows](https://github.com/b3log/wide/issues/32)
|
||||
* [Rename directory](https://github.com/b3log/wide/issues/251)
|
||||
|
||||
## Terms
|
||||
|
||||
* This software is open sourced under the Apache License 2.0
|
||||
* You can not get rid of the "Powered by [B3log](https://b3log.org)" from any page, even which you made
|
||||
* If you want to use this software for commercial purpose, please mail to support@liuyun.io for a commercial license request
|
||||
* Copyright © b3log.org, all rights reserved
|
||||
|
||||
## Credits
|
||||
|
||||
Wide is made possible by the following open source projects.
|
||||
## 鸣谢
|
||||
|
||||
* [golang](https://golang.org)
|
||||
* [CodeMirror](https://github.com/marijnh/CodeMirror)
|
||||
|
|
|
|||
Loading…
Reference in New Issue