add English introduction

This commit is contained in:
Xen 2020-05-31 09:53:11 +08:00
parent aa37864697
commit e1d6d2a4de
2 changed files with 93 additions and 5 deletions

View File

@ -2,11 +2,7 @@
`comNG` 是一款具有现代化 UI 设计并且功能强大的串口助手软件。 `comNG` 是一款具有现代化 UI 设计并且功能强大的串口助手软件。
`Github` 上也有 `comNG` 的 repo但是 github 的访问和上传速度太慢comNG 的编译软件比较大60M 左右),所以后期的更新、维护和发布会以 gitee 为主。 `comNG` is a powerful serial port tool with modern UI design. For English users, please refer to [comNG Introduction](doc/Introduction-en.md)
由于软件比较大,且没有自动化编译环境,所以只有在发布大版本时才会提供 Mac 和 Debian 的安装文件,小版本只会提供 Win10 的安装文件。
目前 github 和 sourceforge 上的本版比 gitee 上的版本都低,建议在 gitee 上下载最新版本。
## 文档 ## 文档

92
doc/Introduction-en.md Normal file
View File

@ -0,0 +1,92 @@
# comNG
A modern and powerful COM tool.
## Doc
For a more detailed doc please refer to: [comNG Introduction](https://xenkuo.github.io/2019-08-01-comNG/)
## Installation
On github or sourceforge, only Windows installer offered as upload installer file is too slow for me. For Mac or Debian installation, you can compile and install from source code or goto [comNG on gitee](https://gitee.com/xenkuo/comNG/releases) to get certain installer, a registration may be needed.
## Introduction
Focus on stable serialport communication and best **on-site data explore**, **comNG** is the Next Generation of COM tool. comNG gives you best experience of on-site log exploring. comNG implemented several features to hit the mark:
- built-in comNGLang syntax
- built-in word highlighter
- globally highlight word you selected (monaco built-in)
- globally highlight word you searched (monaco built-in)
- breakpoint on certain text
- timestamp append and name sign
- cross platform: Windows, Linux and Mac
- powerful Hex mode
- a simple simulated terminal mode
Of course it supports common features that other COM tools have:
- baud rate customize
- hex receive and transmit
- flow control
- modem signals indicats and control
- receive timestamp
- text transmit
- file save and open, drag-drop is supported
Features not supported:
- file transmit
- capture to file
## User Interface
![image](../image/preview.jpg)
![image](../image/demo.gif)
## Usage
Download the release package according with you system, install, comNG should work well then.
For Linux user, you may need to add right to COM port before monitor it:
`sudo chmod 666 /dev/ttyS1`
Replace `ttyS1` with your real COM port.
## Development
### Clone Code
```
git clone git@github.com:xenkuo/comNG.git
```
### Install Dependencies
```
cd comNG
yarn
```
You may need to install node native compile tools, if there are problems, `Google` or create issue.
> For Chinese developer, I'd like to advice you use below `.npmrc` file:
```
registry=https://registry.npm.taobao.org
electron_mirror=https://cdn.npm.taobao.org/dist/electron/
electron_custom_dir=7.1.11
```
### Develop
```
code .
yarn start
yarn make
```
## Licence
comNG is [MIT](https://opensource.org/licenses/MIT) licensed and all it's dependencies are MIT licensed.