Skip to content

Commit 3f7bed2

Browse files
Update README.md
1 parent 3cbda01 commit 3f7bed2

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,23 @@ SwiftTerm
44
=========
55

66
SwiftTerm is a VT100/Xterm terminal emulator for Swift applications that can be embedded
7-
into macOS or iOS applications.
7+
into macOS, iOS applications, or headless applications.
88

99
This repository contains both a terminal emulator engine that is UI agnostic, as well as
10-
front-ends for this engine for iOS using UIKit, and macOS using AppKit. Additionally
11-
there are a couple of minimal sample apps for Mac and iOS showing how to use the library.
10+
front-ends for this engine for iOS using UIKit, and macOS using AppKit. A curses-based
11+
terminal emulator (to emulate an xterm inside a console application) is available as
12+
part of the [TermKit](https://github.com/migueldeicaza/TermKit) library.
13+
14+
There are a couple of minimal sample apps for Mac and iOS showing how to use the library
15+
inside the `TerminalApp` directory. The Mac app has much of the functionality of
16+
MacOS' Terminal.app, but without the configuration UI. The iOS application uses an SSH
17+
library to connect to a remote system (as there is no native shell on iOS to run), and
18+
the sample happens to be hardcoded to my home machine, you can change that in the source
19+
code.
1220

1321
The companion module [SwiftTermApp](https://github.com/migueldeicaza/SwiftTermApp) builds
1422
an actual iOS app that uses this library and is more complete than the testing apps in
15-
this module.
23+
this module and provides a proper configuration UI.
1624

1725
Check the [API Documentation](https://migueldeicaza.github.io/SwiftTerm/)
1826

@@ -79,9 +87,11 @@ Features
7987
* Supports mouse events
8088
* Supports terminal resizing operations (controlled by remote host, or locally)
8189
* [Hyperlinks](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda) in terminal output
82-
* AppKit, UIKit front-ends
90+
* AppKit, UIKit front-ends; ncruses front-end [provided separately](https://github.com/migueldeicaza/TermKit)
8391
* Local process and SSH connection support (some assembly required for the last one)
8492
* Proper CoreText rendering can munch through the hardened Unicode test suites.
93+
* Sixel graphics
94+
* Fuzzed and abused
8595
* Seems pretty fast to me
8696

8797
Using SwiftTerm
@@ -162,7 +172,10 @@ iOS support:
162172

163173
<img width="981" alt="image" src="https://user-images.githubusercontent.com/36863/80056069-54a05580-84f1-11ea-8597-5a227c9c64a7.png">
164174

165-
Screenshots
175+
Sixel support:
176+
177+
<img width="770" alt="image" src="https://user-images.githubusercontent.com/36863/115647346-97a62c00-a2f1-11eb-929a-f9d942cc0c09.png">
178+
166179

167180
# Authors
168181

0 commit comments

Comments
 (0)