Update README

Signed-off-by: Jianhui Zhao <jianhuizhao329@gmail.com>
This commit is contained in:
Jianhui Zhao
2018-08-22 21:53:18 +08:00
parent b2fb1e488c
commit 10355efe80
2 changed files with 27 additions and 13 deletions
+13 -6
View File
@@ -18,20 +18,21 @@ The server side of [rtty](https://github.com/zhaojh329/rtty)
`Keep Watching for More Actions on This Space`
# How to install
# How to install and run
## Download the compiled file(x64)
https://github.com/zhaojh329/rttys/releases
## Decompress the file to your root path
## Linux
### Decompress the file you downloaded to your root path
sudo tar -zxvf rttys-x64.tar.gz -C /
## Manual run
### Manual run
sudo rttys -cert /etc/rttys/rttys.crt -key /etc/rttys/rttys.key
## See Supported Command Line Parameters
### See Supported Command Line Parameters
$ rttys -h
Usage of rttys:
@@ -42,15 +43,21 @@ https://github.com/zhaojh329/rttys/releases
-port int
http service port (default 5912)
## Run in background (Ubuntu)
### Run in background (Ubuntu)
sudo update-rc.d rttys defaults
sudo /etc/init.d/rttys start
View log
### View log
cat /var/log/rtty.log
## Windows
### First unzip the file you downloaded
### Open Command Prompt and enter the directory where rttys.exe is located
rttys -cert rttys.crt -key rttys.key
# Contributing
If you would like to help making [rttys](https://github.com/zhaojh329/rttys) better,
see the [CONTRIBUTING.md](https://github.com/zhaojh329/rttys/blob/master/CONTRIBUTING.md) file.
+14 -7
View File
@@ -18,20 +18,21 @@
`请保持关注以获取最新的项目动态`
# How to install
## 下载编译好的文件(x64)
# 如何安装和运行
## Linux
### 下载编译好的文件(x64)
https://github.com/zhaojh329/rttys/releases
## 解压到你的根目录
### 解压到你的根目录
sudo tar -zxvf rttys-x64.tar.gz -C /
## 手动运行
### 手动运行
sudo rttys -cert /etc/rttys/rttys.crt -key /etc/rttys/rttys.key
## 查看支持哪些命令参数
### 查看支持哪些命令参数
$ rttys -h
Usage of rttys:
@@ -42,15 +43,21 @@ https://github.com/zhaojh329/rttys/releases
-port int
http service port (default 5912)
## 后台运行 (Ubuntu)
### 后台运行 (Ubuntu)
sudo update-rc.d rttys defaults
sudo /etc/init.d/rttys start
查看日志
### 查看日志
cat /var/log/rtty.log
## Windows
### 首先解压你下载的文件
### 打开命令提示符,然后进入到 rttys.exe 所在目录
rttys -cert rttys.crt -key rttys.key
# 贡献代码
如果你想帮助[rttys](https://github.com/zhaojh329/rttys)变得更好,请参考
[CONTRIBUTING_ZH.md](https://github.com/zhaojh329/rttys/blob/master/CONTRIBUTING_ZH.md)。