diff --git a/README.md b/README.md index 80ebd67..bcf94fa 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,47 @@ +
+🇨🇳 简体中文 +
+ # Termora -**Termora** 是一个终端模拟器和 SSH 客户端,支持 Windows,macOS 和 Linux。 +**Termora** is a terminal emulator and SSH client for Windows, macOS and Linux.
termora
-**Termora** 采用 [Kotlin/JVM](https://kotlinlang.org/) 开发并实现了 [XTerm](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html) 协议(尚未完全实现),它的最终目标是通过 [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) 实现全平台(含 Android、iOS、iPadOS 等)。 +**Termora** is developed using [Kotlin/JVM](https://kotlinlang.org) and partially implements the [XTerm](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html) protocol (with ongoing improvements). Its ultimate vision is to achieve full platform support (including Android, iOS, and iPadOS) through [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html). -## 功能特性 +## Features -- 支持 SSH 和本地终端 -- 支持 [SFTP](./docs/sftp-zh_CN.png) 文件传输 -- 支持 Windows、macOS、Linux 平台 -- 支持 Zmodem 协议 -- 支持 SSH 端口转发 -- 支持配置同步到 [Gist](https://gist.github.com) -- 支持宏(录制脚本并回放) -- 支持关键词高亮 -- 支持密钥管理器 -- 支持将命令发送到多个会话 -- 支持 [Find Everywhere](./docs/findeverywhere.png) 快速跳转 -- 支持数据加密 +- SSH and local terminal support +- [SFTP](./docs/sftp.png?raw=1) file transfer support +- Compatible with Windows, macOS, and Linux +- Zmodem protocol support +- SSH port forwarding +- Configuration synchronization via [Gist](https://gist.github.com) +- Macro support (record and replay scripts) +- Keyword highlighting +- Key management +- Broadcast commands to multiple sessions +- [Find Everywhere](./docs/findeverywhere.png?raw=1) quick navigation +- Data encryption - ... -## 下载 +## Download -- [releases](https://github.com/TermoraDev/termora/releases/latest) +Get the latest version from the [Releases](https://github.com/TermoraDev/termora/releases/latest) page. -### macOS +## Development -由于苹果开发者证书正在申请中,所以 macOS 用户需要执行 `sudo xattr -r -d com.apple.quarantine /Applications/Termora.app` 后才可以运行程序。 +It is recommended to use the [JetBrainsRuntime](https://github.com/JetBrains/JetBrainsRuntime) version of the JDK and run the program via `./gradlew :run` to run the program. -## 开发 +The program can be run via `./gradlew dist` to automatically build the local version. On macOS: `dmg`, on Windows: `zip`, on Linux: `tar.gz`. -建议使用 [JetBrainsRuntime](https://github.com/JetBrains/JetBrainsRuntime) 的 JDK 版本,通过 `./gradlew :run` 即可运行程序。 -通过 `./gradlew dist` 可以自动构建适用于本机的版本。在 macOS 上是:`dmg`,在 Windows 上是:`zip`,在 Linux 上是:`tar.gz`。 +## LICENSE -## 协议 +This software is distributed under a dual-license model. You may choose one of the following options: -本软件采用双重许可模式,您可以选择以下任意一种许可方式: - -- AGPL-3.0:根据 [AGPL-3.0](https://opensource.org/license/agpl-v3) 的条款,您可以自由使用、分发和修改本软件。 -- 专有许可:如果希望在闭源或专有环境中使用,请联系作者获取许可。 +- AGPL-3.0: Use, distribute, and modify the software under the terms of the [AGPL-3.0](https://opensource.org/license/agpl-v3). +- Proprietary License: For closed-source or proprietary use, please contact the author to obtain a commercial license. diff --git a/README.zh_CN.md b/README.zh_CN.md new file mode 100644 index 0000000..246c7f7 --- /dev/null +++ b/README.zh_CN.md @@ -0,0 +1,42 @@ +# Termora + +**Termora** 是一个终端模拟器和 SSH 客户端,支持 Windows,macOS 和 Linux。 + +
+ termora +
+ +**Termora** 采用 [Kotlin/JVM](https://kotlinlang.org/) 开发并实现了 [XTerm](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html) 协议(尚未完全实现),它的最终目标是通过 [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) 实现全平台(含 Android、iOS、iPadOS 等)。 + +## 功能特性 + +- 支持 SSH 和本地终端 +- 支持 [SFTP](./docs/sftp-zh_CN.png?raw=1) 文件传输 +- 支持 Windows、macOS、Linux 平台 +- 支持 Zmodem 协议 +- 支持 SSH 端口转发 +- 支持配置同步到 [Gist](https://gist.github.com) +- 支持宏(录制脚本并回放) +- 支持关键词高亮 +- 支持密钥管理器 +- 支持将命令发送到多个会话 +- 支持 [Find Everywhere](./docs/findeverywhere-zh_CN.png?raw=1) 快速跳转 +- 支持数据加密 +- ... + +## 下载 + +从 [Releases](https://github.com/TermoraDev/termora/releases/latest) 页面获取最新版本 + +## 开发 + +建议使用 [JetBrainsRuntime](https://github.com/JetBrains/JetBrainsRuntime) 的 JDK 版本,通过 `./gradlew :run` 即可运行程序。 + +通过 `./gradlew dist` 可以自动构建适用于本机的版本。在 macOS 上是:`dmg`,在 Windows 上是:`zip`,在 Linux 上是:`tar.gz`。 + +## 协议 + +本软件采用双重许可模式,您可以选择以下任意一种许可方式: + +- AGPL-3.0:根据 [AGPL-3.0](https://opensource.org/license/agpl-v3) 的条款,您可以自由使用、分发和修改本软件。 +- 专有许可:如果希望在闭源或专有环境中使用,请联系作者获取许可。 diff --git a/docs/findeverywhere-zh_CN.png b/docs/findeverywhere-zh_CN.png new file mode 100644 index 0000000..90237e0 Binary files /dev/null and b/docs/findeverywhere-zh_CN.png differ diff --git a/docs/findeverywhere.png b/docs/findeverywhere.png index 90237e0..fc9856d 100644 Binary files a/docs/findeverywhere.png and b/docs/findeverywhere.png differ diff --git a/docs/readme-zh_CN.png b/docs/readme-zh_CN.png new file mode 100644 index 0000000..0971a14 Binary files /dev/null and b/docs/readme-zh_CN.png differ diff --git a/docs/readme.png b/docs/readme.png index 0971a14..3b8558e 100644 Binary files a/docs/readme.png and b/docs/readme.png differ