diff --git a/README.md b/README.md index f4cc4c5c..85cc9c24 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,92 @@ -![](https://github.com/Eugeny/terminus/raw/master/docs/readme.png) +![](docs/readme.png) -

- GitHub AppVeyor -

-

GitHub All Releases Gitter

---- -**Terminus** is a highly configurable terminal emulator for Windows, macOS and Linux +**Terminus** is a highly configurable terminal emulator, SSH and serial client for Windows, macOS and Linux - * Integrated SSH client and connection manager - * Theming and color schemes - * Fully configurable shortcuts - * Split panes - * Remembers your tabs - * PowerShell (and PS Core), WSL, Git-Bash, Cygwin, Cmder and CMD support - * Direct file transfer from/to SSH sessions via Zmodem - * Full Unicode support including double-width characters - * Doesn't choke on fast-flowing outputs - * Proper shell experience on Windows including tab completion (via Clink) +* Integrated SSH client and connection manager +* Integrated serial terminal +* Theming and color schemes +* Fully configurable shortcuts and multi-chord shortcuts +* Split panes +* Remembers your tabs +* PowerShell (and PS Core), WSL, Git-Bash, Cygwin, Cmder and CMD support +* Direct file transfer from/to SSH sessions via Zmodem +* Full Unicode support including double-width characters +* Doesn't choke on fast-flowing outputs +* Proper shell experience on Windows including tab completion (via Clink) [![Buy me a coffee](https://github.com/Eugeny/terminus/raw/master/docs/kofi.png)](https://ko-fi.com/eugeny) --- +# Contents + +- [Contents](#contents) +- [What Terminus is and isn't](#what-terminus-is-and-isnt) +- [Terminal features](#terminal-features) +- [SSH Client](#ssh-client) +- [Serial Terminal](#serial-terminal) +- [Portable](#portable) +- [Plugins](#plugins) +- [Themes](#themes) +- [Contributing](#contributing) + + +# What Terminus is and isn't + * **Terminus is** an alternative to Windows' standard terminal (conhost), PowerShell ISE, PuTTY or iTerm * **Terminus is not** a new shell or a MinGW or Cygwin replacement. Neither is it lightweight - if RAM usage is of importance, consider [Conemu](https://conemu.github.io) or [Alacritty](https://github.com/jwilm/alacritty) ---- + +# Terminal features +![](docs/readme-terminal.png) + +* A V220 terminal + various extensions +* Multiple nested split panes +* Tabs on any side of the window +* Optional dockable window with a global spawn hotkey ("Quake console") +* Progress detection +* Notification on process completion +* Bracketed paste, multiline paste warnings +* Font ligatures +* Custom shell profiles +* Optional RMB paste and copy-on select (PuTTY style) + + +# SSH Client + +![](docs/readme-ssh.png) + +* SSH2 client with a connection manager +* X11 and port forwarding +* Automatic jump host management +* Agent forwarding (incl. Pageant and Windows native OpenSSH Agent) +* Login scripts + + +# Serial Terminal + +* Saved connections +* Readline input support +* Optional hex byte-by-byte input and hexdump output +* Newline conversion +* Automatic reconnection + + # Portable -For portable in windows, user can create folder `data` at the same directory as `Terminal.exe` to save the settings. +Terminus will run as a portable app on Windows, if you create a `data` folder in the same location where `Terminus.exe` lives. + # Plugins Plugins and themes can be installed directly from the Settings view inside Terminus. @@ -49,6 +97,7 @@ Plugins and themes can be installed directly from the Settings view inside Termi * [save-output](https://github.com/Eugeny/terminus-save-output) - record terminal output into a file * [scrollbar](https://github.com/kbjr/terminus-scrollbar) - adds a scrollbar to hterm tabs + # Themes * [hype](https://github.com/Eugeny/terminus-theme-hype) - a Hyper inspired theme @@ -57,8 +106,7 @@ Plugins and themes can be installed directly from the Settings view inside Termi * [windows10](https://www.npmjs.com/package/terminus-theme-windows10) * [altair](https://github.com/yxuko/terminus-altair) ---- - + # Contributing Pull requests and plugins are welcome! @@ -66,6 +114,7 @@ Pull requests and plugins are welcome! See [HACKING.md](https://github.com/Eugeny/terminus/blob/master/HACKING.md) and [API docs](http://ajenti.org/terminus-docs/) for information of how the project is laid out, and a very brief plugin development tutorial. --- + Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): diff --git a/docs/readme-ssh.png b/docs/readme-ssh.png new file mode 100644 index 00000000..3ab51736 Binary files /dev/null and b/docs/readme-ssh.png differ diff --git a/docs/readme-terminal.png b/docs/readme-terminal.png new file mode 100644 index 00000000..ffc1059f Binary files /dev/null and b/docs/readme-terminal.png differ