diff --git a/README.md b/README.md old mode 100755 new mode 100644 index f7156f8..65df597 --- a/README.md +++ b/README.md @@ -1,49 +1,49 @@ -# rttys([中文](/README_ZH.md)) - -[1]: https://img.shields.io/badge/license-LGPL2-brightgreen.svg?style=plastic -[2]: /LICENSE -[3]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=plastic -[4]: https://github.com/zhaojh329/rttys/pulls -[5]: https://img.shields.io/badge/Issues-welcome-brightgreen.svg?style=plastic -[6]: https://github.com/zhaojh329/rttys/issues/new - -[![license][1]][2] -[![PRs Welcome][3]][4] -[![Issue Welcome][5]][6] - -The server side of [rtty](https://github.com/zhaojh329/rtty) - -`Keep Watching for More Actions on This Space` - -# How to install -## Download the compiled file according to your own platform - -https://github.com/zhaojh329/rttys/releases - -## Decompress the file to your root path - - sudo tar -zxvf rttys-x64.tar.gz -C / - -## Manual run - - rttys -cert /etc/rttys/rttys.crt -key /etc/rttys/rttys.key - -## See Supported Command Line Parameters - - $ rttys -h - Usage of rttys: - -cert string - certFile Path - -key string - keyFile Path - -port int - http service port (default 5912) - -## Run in background (Ubuntu) - - update-rc.d rttys defaults - sudo /etc/init.d/rttys start - -# 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. +# rttys([中文](/README_ZH.md)) + +[1]: https://img.shields.io/badge/license-LGPL2-brightgreen.svg?style=plastic +[2]: /LICENSE +[3]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=plastic +[4]: https://github.com/zhaojh329/rttys/pulls +[5]: https://img.shields.io/badge/Issues-welcome-brightgreen.svg?style=plastic +[6]: https://github.com/zhaojh329/rttys/issues/new + +[![license][1]][2] +[![PRs Welcome][3]][4] +[![Issue Welcome][5]][6] + +The server side of [rtty](https://github.com/zhaojh329/rtty) + +`Keep Watching for More Actions on This Space` + +# How to install +## Download the compiled file according to your own platform + +https://github.com/zhaojh329/rttys/releases + +## Decompress the file to your root path + + sudo tar -zxvf rttys-x64.tar.gz -C / + +## Manual run + + rttys -cert /etc/rttys/rttys.crt -key /etc/rttys/rttys.key + +## See Supported Command Line Parameters + + $ rttys -h + Usage of rttys: + -cert string + certFile Path + -key string + keyFile Path + -port int + http service port (default 5912) + +## Run in background (Ubuntu) + + update-rc.d rttys defaults + sudo /etc/init.d/rttys start + +# 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. diff --git a/README_ZH.md b/README_ZH.md old mode 100755 new mode 100644 index 93b9ca3..d1539d8 --- a/README_ZH.md +++ b/README_ZH.md @@ -1,52 +1,52 @@ -# rttys - -[1]: https://img.shields.io/badge/license-LGPL2-brightgreen.svg?style=plastic -[2]: /LICENSE -[3]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=plastic -[4]: https://github.com/zhaojh329/rttys/pulls -[5]: https://img.shields.io/badge/Issues-welcome-brightgreen.svg?style=plastic -[6]: https://github.com/zhaojh329/rttys/issues/new - -[![license][1]][2] -[![PRs Welcome][3]][4] -[![Issue Welcome][5]][6] - -[rtty](https://github.com/zhaojh329/rtty)的服务端。 - -`请保持关注以获取最新的项目动态` - -# How to install -## 根据自己的平台下载编译好的文件 - -https://github.com/zhaojh329/rttys/releases - -## 解压到你的根目录 - - sudo tar -zxvf rttys-x64.tar.gz -C / - -## 手动运行 - - rttys -cert /etc/rttys/rttys.crt -key /etc/rttys/rttys.key - -## 查看支持哪些命令参数 - - $ rttys -h - Usage of rttys: - -cert string - certFile Path - -key string - keyFile Path - -port int - http service port (default 5912) - -## 后台运行 (Ubuntu) - - update-rc.d rttys defaults - sudo /etc/init.d/rttys start - -# 贡献代码 -如果你想帮助[rttys](https://github.com/zhaojh329/rttys)变得更好,请参考 -[CONTRIBUTING_ZH.md](https://github.com/zhaojh329/rttys/blob/master/CONTRIBUTING_ZH.md)。 - -# 技术交流 -QQ群:153530783 +# rttys + +[1]: https://img.shields.io/badge/license-LGPL2-brightgreen.svg?style=plastic +[2]: /LICENSE +[3]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=plastic +[4]: https://github.com/zhaojh329/rttys/pulls +[5]: https://img.shields.io/badge/Issues-welcome-brightgreen.svg?style=plastic +[6]: https://github.com/zhaojh329/rttys/issues/new + +[![license][1]][2] +[![PRs Welcome][3]][4] +[![Issue Welcome][5]][6] + +[rtty](https://github.com/zhaojh329/rtty)的服务端。 + +`请保持关注以获取最新的项目动态` + +# How to install +## 根据自己的平台下载编译好的文件 + +https://github.com/zhaojh329/rttys/releases + +## 解压到你的根目录 + + sudo tar -zxvf rttys-x64.tar.gz -C / + +## 手动运行 + + rttys -cert /etc/rttys/rttys.crt -key /etc/rttys/rttys.key + +## 查看支持哪些命令参数 + + $ rttys -h + Usage of rttys: + -cert string + certFile Path + -key string + keyFile Path + -port int + http service port (default 5912) + +## 后台运行 (Ubuntu) + + update-rc.d rttys defaults + sudo /etc/init.d/rttys start + +# 贡献代码 +如果你想帮助[rttys](https://github.com/zhaojh329/rttys)变得更好,请参考 +[CONTRIBUTING_ZH.md](https://github.com/zhaojh329/rttys/blob/master/CONTRIBUTING_ZH.md)。 + +# 技术交流 +QQ群:153530783