Skip to content

Commit ea73826

Browse files
committed
Doc update
1 parent 992504e commit ea73826

2 files changed

Lines changed: 13 additions & 10 deletions

File tree

Documentation.docc/Documentation.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,16 @@ The sample Mac app has much of the functionality of MacOS' Terminal.app, but wit
2424
top of it.
2525
* Selection engine (with macOS support in the view)
2626
* Supports colors (ANSI, 256, TrueColor)
27+
* Supports text attributes including bold, italic, underline, strikethrough, and dim/faint (SGR 2)
2728
* Supports mouse events
2829
* Supports terminal resizing operations (controlled by remote host, or locally)
2930
* [Hyperlinks](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda) in terminal output
30-
* AppKit, UIKit front-ends; ncruses front-end [provided separately](https://github.com/migueldeicaza/TermKit)
31+
* AppKit, UIKit front-ends; ncurses front-end [provided separately](https://github.com/migueldeicaza/TermKit)
3132
* Local process and SSH connection support (some assembly required for the last
3233
one)
3334
* Proper CoreText rendering can munch through the hardened Unicode test suites.
34-
* Sixel graphics (Use img2sixel to test)
35-
* iTerm2-style graphic rendering (Use imgcat to test)
35+
* Graphics support: Sixel, iTerm2-style images, and Kitty graphics protocol
36+
* Thread-safe Terminal instances
3637
* Fuzzed and abused
3738
* Seems pretty fast to me
3839

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,8 @@ part of the [TermKit](https://github.com/migueldeicaza/TermKit) library.
1919
use the library inside the `TerminalApp` directory.
2020

2121
* The sample Mac app has much of the functionality of MacOS' Terminal.app, but without the configuration UI.
22-
* The sample iOS application uses an SSH library to connect to a remote system (as there is no native shell
23-
on iOS to run), and the sample happens to be hardcoded to my home machine, you can change that in the source
24-
code.
22+
* The sample iOS application uses an SSH library to connect to a remote system (as there is no native shell
23+
on iOS to run) and includes a login UI to configure the connection.
2524

2625
## Companion Apps
2726

@@ -55,6 +54,7 @@ Features
5554
* [Pane](https://github.com/migueldeicaza/pane) implements a terminal multiplexor
5655
* Selection engine (with macOS support in the view)
5756
* Supports colors (ANSI, 256, TrueColor)
57+
* Supports text attributes including bold, italic, underline, strikethrough, and dim/faint (SGR 2)
5858
* Supports mouse events
5959
* Supports terminal resizing operations (controlled by remote host, or locally)
6060
* [Hyperlinks](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda) in terminal output
@@ -65,6 +65,7 @@ Features
6565
* iTerm2-style graphic rendering (Use imgcat to test)
6666
* Kitty graphics (Use kittyimg to test)
6767
* Terminal session recording and playback with termcast
68+
* Thread-safe Terminal instances
6869
* Fuzzed and abused
6970
* Seems pretty fast to me
7071

@@ -111,10 +112,11 @@ The iOS and UIKit code share a lot of the code, that code lives under the Apple
111112

112113
## Using SSH
113114
The core library currently does not provide a convenient way to connect to SSH, purely
114-
to avoid the additional dependency. But this git module references a module that pulls
115-
a precompiled SSH client ([Frugghi's SwiftSH](https://github.com/migueldeicaza/SwiftSH)), along with
116-
a [`UIKitSsshTerminalView`](https://github.com/migueldeicaza/SwiftTerm/blob/main/TerminalApp/iOSTerminal/UIKitSshTerminalView.swift)
117-
in the iOS sample that that connects the `TerminalView` for iOS to an SSH connection.
115+
to avoid the additional dependency. The iOS sample app demonstrates how to integrate SSH
116+
using a modern SSH stack with [swift-nio-ssh](https://github.com/apple/swift-nio-ssh). See
117+
[`UIKitSshTerminalView`](https://github.com/migueldeicaza/SwiftTerm/blob/main/TerminalApp/iOSTerminal/UIKitSshTerminalView.swift)
118+
and [`SSHLoginView`](https://github.com/migueldeicaza/SwiftTerm/blob/main/TerminalApp/iOSTerminal/SSHLoginView.swift)
119+
for an example of connecting the `TerminalView` for iOS to an SSH connection.
118120

119121
## Termcast - Terminal Recording and Playback
120122

0 commit comments

Comments
 (0)