You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-6Lines changed: 19 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,23 @@ SwiftTerm
4
4
=========
5
5
6
6
SwiftTerm is a VT100/Xterm terminal emulator for Swift applications that can be embedded
7
-
into macOSor iOS applications.
7
+
into macOS, iOS applications, or headless applications.
8
8
9
9
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.
12
20
13
21
The companion module [SwiftTermApp](https://github.com/migueldeicaza/SwiftTermApp) builds
14
22
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.
16
24
17
25
Check the [API Documentation](https://migueldeicaza.github.io/SwiftTerm/)
18
26
@@ -79,9 +87,11 @@ Features
79
87
* Supports mouse events
80
88
* Supports terminal resizing operations (controlled by remote host, or locally)
81
89
*[Hyperlinks](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda) in terminal output
0 commit comments