Browse Source

docs: edit English documentation

master
yangpei 4 years ago
committed by smallstonesk
parent
commit
46ae7c9faa
  1. 78
      README.en-US.md
  2. 59
      README.md
  3. 20
      README.zh-CN.md

78
README.en-US.md

@ -0,0 +1,78 @@
# iMove
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<div align="center">
<img src="https://ss1.bdstatic.com/70cFuXSh_Q1YnxGkpoWK1HF6hhy/it/u=3874775950,1064987171&fm=26&gp=0.jpg" width="200px">
</div>
<p align="center">
iMove is a logic-reusable, function-oriented and process-visualized JavaScript tool library.
</p>
[English](./README.en-US.md) | 简体中文
## 特性
- [x] **Process visualization:** iMove is easy to use and easy to draw. Its logical expression is more intuitive and easy to understand.
- [x] **Logic re-usage:** iMove node supports multiplexing, and its single node supports parameter configuration.
- [x] **Flexible**: We need to write an only function. The node can also be extended. iMove can alse support plug-in integration.
- [ ] **Multi-language compilation**: There is no language compiling code limitation (example: support JavaScript, Java compiling code).
## 快速开始
### 步骤 1. 准备
Download this project, install dependencies and start the project.
```bash
$ git clone https://github.com/imgcook/imove.git
$ cd ./imove/example
$ npm install
$ npm start
```
### 步骤 2. 绘制流程图
Drag nodes from the left panel and drop them into the center, then we can get a flowchart.
![flowchart](https://img.alicdn.com/tfs/TB1aoYe4pP7gK0jSZFjXXc5aXXa-3090-1806.jpg)
### 步骤 3. 配置节点
Select the node, modify its display name and complete the code.
![flowchart-usage1](https://img.alicdn.com/tfs/TB1z6DKoZieb18jSZFvXXaI3FXa-1924-1125.png)
![flowchart-usage2](https://img.alicdn.com/tfs/TB1lC26tTM11u4jSZPxXXahcXXa-1924-1125.png)
## 贡献
1. Fork 仓库
2. 创建分支 (`git checkout -b my-new-feature`)
3. 提交修改 (`git commit -am 'Add some feature'`)
4. 推送 (`git push origin my-new-feature`)
5. 创建 PR
## 欢迎fork和反馈
If you have any suggestion, welcome to github to raise [issues](https://github.com/imgcook/imove/issues).
## 协议
本仓库遵循 [MIT 协议](http://www.opensource.org/licenses/MIT)
## 贡献者 ✨
Thanks goes to these excellent ([contributors](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
本仓库遵循 [all-contributors](https://github.com/all-contributors/all-contributors) 规范,欢迎贡献!

59
README.md

@ -1,4 +1,5 @@
# iMove
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
@ -8,64 +9,64 @@
</div>
<p align="center">
iMove is a logic-reusable, function-oriented and process visualized JavaScript tool library.
iMove 是一个逻辑可复用的,面向函数的,流程可视化的 JavaScript 工具库。
</p>
English | [简体中文](./README.zh-CN.md)
[English](./README.en-US.md) | 简体中文
## Features
## 特性
- [x] **Process visualization:** easy to draw flow chart, logical expression is more intuitive and easy to understand
- [x] **Logic re-usage:** iMove nodes support re-using, and every node is configurable
- [x] **Flexible**: only the code is required, each iMove node is extendable and plugin can be integrated
- [ ] **Multi-language compilation**: no language compilation limitation (e.g. supports JavaScript, Java compilation)
- [x] **流程可视化**: 上手简单,绘图方便,逻辑表达更直观,易于理解
- [x] **逻辑复用**: iMove 节点支持复用,单节点支持参数配置
- [x] **灵活可扩展**: 仅需写一个函数,节点可扩展,支持插件集成
- [ ] **多语言编译**: 无语言编译出码限制(例: 支持 JavaScript, Java 编译出码)
## Get started
## 快速开始
### Step 1. Prepare
### 步骤 1. 准备
Download this project, install dependencies and start the example.
下载仓库,安装并启动
```bash
$ git clone https://github.com/imgcook/imove.git
$ cd example
$ cd ./imove/example
$ npm install
$ npm start // run example server
$ npm start
```
### Step 2. Draw a flowchart
### 步骤 2. 绘制流程图
Drag nodes from the left panel and drop them into the center to draw a flowchart.
从左侧拖动节点至中央画布,绘制流程图
![flowchart](https://img.alicdn.com/tfs/TB1aoYe4pP7gK0jSZFjXXc5aXXa-3090-1806.jpg)
### Step 3. Config iMove nodes
### 步骤 3. 配置节点
Select node, change node's display name and completes code editing.
选择节点,修改节点名,编辑节点代码
![flowchart-usage1](https://img.alicdn.com/tfs/TB1z6DKoZieb18jSZFvXXaI3FXa-1924-1125.png)
![flowchart-usage2](https://img.alicdn.com/tfs/TB1lC26tTM11u4jSZPxXXahcXXa-1924-1125.png)
## Contributing
## 贡献
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
1. Fork 仓库
2. 创建分支 (`git checkout -b my-new-feature`)
3. 提交修改 (`git commit -am 'Add some feature'`)
4. 推送 (`git push origin my-new-feature`)
5. 创建 PR
## Welcome fork and feedbacks
## 欢迎fork和反馈
If you have suggestion, welcome github [issues](https://github.com/imgcook/imove/issues).
如有建议或意见,欢迎在 github [issues](https://github.com/imgcook/imove/issues) 区提问
## License
## 协议
This repo is released under the [MIT License](http://www.opensource.org/licenses/MIT).
本仓库遵循 [MIT 协议](http://www.opensource.org/licenses/MIT)
## Contributors
## 贡献者
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
感谢所有贡献的人 ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
@ -74,4 +75,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
本仓库遵循 [all-contributors](https://github.com/all-contributors/all-contributors) 规范,欢迎贡献!

20
README.zh-CN.md

@ -1,5 +1,9 @@
# iMove
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<div align="center">
<img src="https://ss1.bdstatic.com/70cFuXSh_Q1YnxGkpoWK1HF6hhy/it/u=3874775950,1064987171&fm=26&gp=0.jpg" width="200px">
</div>
@ -8,8 +12,7 @@
iMove 是一个逻辑可复用的,面向函数的,流程可视化的 JavaScript 工具库。
</p>
[English](./README.md) | 简体中文
[English](./README.en-US.md) | 简体中文
## 特性
@ -60,3 +63,16 @@ $ npm start
## 协议
本仓库遵循 [MIT 协议](http://www.opensource.org/licenses/MIT)
## 贡献者 ✨
感谢所有贡献的人 ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
本仓库遵循 [all-contributors](https://github.com/all-contributors/all-contributors) 规范,欢迎贡献!

Loading…
Cancel
Save