From 7a3c97bedd3de2c98d95a8e1697359900df00405 Mon Sep 17 00:00:00 2001 From: reionwong Date: Mon, 19 Oct 2026 21:42:30 +0800 Subject: [PATCH] docs(terminal): describe the toolkit-based terminal core in its README --- qmltermwidget/README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/qmltermwidget/README.md b/qmltermwidget/README.md index 4208721..9fea430 100644 --- a/qmltermwidget/README.md +++ b/qmltermwidget/README.md @@ -1,13 +1,20 @@ -# QMLTermWidget +# Terminal core -This project is a QML port of qtermwidget. I'm trying to keep it close to the upstream project. The main branch as been migrated to Qt6, please check the qt5 branch for the latest qt5 version. +The terminal's emulator, session, pty and display. The emulation, history, +key translation and colour schemes are derived from Konsole by way of +[qmltermwidget](https://github.com/Swordfish90/qmltermwidget); the display +and font handling are rewritten on +[cutefish-toolkit](https://github.com/cutefishos/cutefish-toolkit). -At the moment this plugin is powering cool-retro-term and some other QML terminal emulators. +It builds as two static libraries for the terminal: -## Building +- `terminal-core`: emulation, screen, history, sessions and the pty. +- `terminal-view`: `TerminalView` and `TerminalFont`, the toolkit display. -`qmake && make`, then try the included minimal terminal application `qml -I . test-app/test-app.qml`. +Colour schemes (`lib/color-schemes`, see `THEMES.md`) and keyboard layouts +(`lib/kb-layouts`) are installed under `share/cutefish-terminal`. ## Licensing -The project is released under GPL-2.0-or-later. Some files are under compatible licenses inherited from upstream QTermWidget; see `LICENSE` and file headers for details. +Released under GPL-2.0-or-later. Some files keep compatible licenses inherited +from upstream; see `LICENSE` and the file headers for details.