Skip to content

Commit 5f20836

Browse files
committed
Documentation link updates
1 parent 3c8310c commit 5f20836

File tree

2 files changed

+20
-18
lines changed

2 files changed

+20
-18
lines changed

Documentation.docc/Documentation.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -43,18 +43,18 @@ add the library to your project by using the url for this project or a
4343
fork of it.
4444

4545
## MacOS NSView
46-
The macOS AppKit NSView implementation [`TerminalView`](https://migueldeicaza.github.io/SwiftTerm/Classes/TerminalView.html) is a reusable
46+
The macOS AppKit NSView implementation [`TerminalView`](https://migueldeicaza.github.io/SwiftTermDocs/documentation/swiftterm/terminalview) is a reusable
4747
NSView control that can be connected to any source by implementing the
48-
[`TerminalViewDelegate`](https://migueldeicaza.github.io/SwiftTerm/Protocols/TerminalViewDelegate.html).
48+
[`TerminalViewDelegate`](https://migueldeicaza.github.io/SwiftTermDocs/documentation/swiftterm/terminalviewdelegate).
4949
I anticipate that a common scenario will be
5050
to host a local Unix command, so I have included
51-
[`LocalProcessTerminalView`](https://migueldeicaza.github.io/SwiftTerm/Classes/LocalProcessTerminalView.html)
51+
[`LocalProcessTerminalView`](https://migueldeicaza.github.io/SwiftTermDocs/documentation/swiftterm/localprocessterminalview)
5252
which is an implementation that connects
5353
the `TerminalView` to a Unix pseudo-terminal and runs a command there.
5454

5555
## iOS UIView
5656
There is an equivalent UIKit UIView implementation for
57-
[`TerminalView`](https://github.com/migueldeicaza/SwiftTerm/blob/main/Sources/SwiftTerm/iOS/iOSTerminalView.swift)
57+
[`TerminalView`](https://migueldeicaza.github.io/SwiftTermDocs/documentation/swiftterm/terminalview)
5858
which like its NSView companion is an embeddable and reusable view
5959
that can be connected to your application by implementing the same
6060
TerminalViewDelegate. Unlike the NSView case running on a Mac, where

README.md

+16-14
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,18 @@ use the library inside the `TerminalApp` directory.
2424
on iOS to run), and the sample happens to be hardcoded to my home machine, you can change that in the source
2525
code.
2626

27-
**Companion App** [SwiftTermApp](https://github.com/migueldeicaza/SwiftTermApp) builds
28-
an actual iOS app that uses this library and is more complete than the testing apps in
29-
this module and provides a proper configuration UI.
27+
**Companion App** [SwiftTermApp](https://github.com/migueldeicaza/SwiftTermApp)
28+
builds an actual iOS app that uses this library and is more complete than the
29+
testing apps in this module and provides a proper configuration UI.
3030

3131

32-
This is a port of my original [XtermSharp](https://github.com/migueldeicaza/XtermSharp), which was
33-
itself based on [xterm.js](https://xtermjs.org). At this point, I consider SwiftTerm
34-
to be a more advanced terminal emulator than both of those (modulo Selection/Accessibility) as
35-
it handles UTF, Unicode and grapheme clusters better than those and has a more complete coverage of
36-
terminal emulation. XtermSharp is generally attempting to keep up.
32+
This is a port of my original
33+
[XtermSharp](https://github.com/migueldeicaza/XtermSharp), which was itself
34+
based on [xterm.js](https://xtermjs.org). At this point, I consider SwiftTerm
35+
to be a more advanced terminal emulator than both of those (modulo
36+
Selection/Accessibility) as it handles UTF, Unicode and grapheme clusters better
37+
than those and has a more complete coverage of terminal emulation. XtermSharp
38+
is generally attempting to keep up.
3739

3840
Features
3941
========
@@ -71,18 +73,18 @@ add the library to your project by using the url for this project or a
7173
fork of it.
7274

7375
## MacOS NSView
74-
The macOS AppKit NSView implementation [`TerminalView`](https://migueldeicaza.github.io/SwiftTerm/Classes/TerminalView.html) is a reusable
76+
The macOS AppKit NSView implementation [`TerminalView`](https://migueldeicaza.github.io/SwiftTermDocs/documentation/swiftterm/terminalview) is a reusable
7577
NSView control that can be connected to any source by implementing the
76-
[`TerminalViewDelegate`](https://migueldeicaza.github.io/SwiftTerm/Protocols/TerminalViewDelegate.html).
78+
[`TerminalViewDelegate`](https://migueldeicaza.github.io/SwiftTermDocs/documentation/swiftterm/terminalviewdelegate).
7779
I anticipate that a common scenario will be
7880
to host a local Unix command, so I have included
79-
[`LocalProcessTerminalView`](https://migueldeicaza.github.io/SwiftTerm/Classes/LocalProcessTerminalView.html)
81+
[`LocalProcessTerminalView`](https://migueldeicaza.github.io/SwiftTermDocs/documentation/swiftterm/localprocessterminalview)
8082
which is an implementation that connects
8183
the `TerminalView` to a Unix pseudo-terminal and runs a command there.
8284

8385
## iOS UIView
8486
There is an equivalent UIKit UIView implementation for
85-
[`TerminalView`](https://github.com/migueldeicaza/SwiftTerm/blob/main/Sources/SwiftTerm/iOS/iOSTerminalView.swift)
87+
[`TerminalView`](https://migueldeicaza.github.io/SwiftTermDocs/documentation/swiftterm/terminalview)
8688
which like its NSView companion is an embeddable and reusable view
8789
that can be connected to your application by implementing the same
8890
TerminalViewDelegate. Unlike the NSView case running on a Mac, where
@@ -134,8 +136,8 @@ GitHub issues has a list of desired features and enhancements
134136
Long Term Plans
135137
===============
136138

137-
In the longer term, I want to also add a tvOS UIView, a [SwiftGtk](https://github.com/rhx/SwiftGtk)
138-
front-end for Linux.
139+
In the longer term, I want to also add a tvOS UIView, a
140+
[SwiftGtk](https://github.com/rhx/SwiftGtk) front-end for Linux.
139141

140142
Screenshots
141143
===========

0 commit comments

Comments
 (0)