aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc25
1 files changed, 19 insertions, 6 deletions
diff --git a/README.adoc b/README.adoc
index 3db0db4..1866b2a 100644
--- a/README.adoc
+++ b/README.adoc
@@ -2,9 +2,9 @@ xK
==
'xK' (chat kit) is an IRC software suite consisting of a daemon, bot, notifier,
-terminal client, and web/Windows/macOS frontends for the client. It's all
-you're ever going to need for chatting, so long as you can make do with slightly
-minimalist software.
+terminal client, and web/Windows/macOS/Linux/FreeBSD/Android/iOS frontends
+for the client. It's all you're ever going to need for chatting, so long as
+you can make do with slightly minimalist software.
They're all lean on dependencies, and offer a maximally permissive licence.
@@ -33,9 +33,10 @@ including link:xC.adoc#_key_bindings[keyboard shortcuts].
image::xP.webp[align="center"]
-xF
---
-The X11 frontend for 'xC', still under development.
+xA, xT, xF, xW, xM
+------------------
+Fyne, Qt Widgets, X11, Win32, Cocoa frontends for 'xC'.
+Using them is not recommended.
xD
--
@@ -147,6 +148,18 @@ For remote use, it's recommended to put 'xP' behind a reverse proxy, with TLS,
and some form of HTTP authentication. Pass the external URL of the WebSocket
endpoint as the third command line argument in this case.
+xA
+~~
+The Fyne frontend supports all of Linux, FreeBSD, Windows, macOS, Android, and
+iOS natively, albeit somewhat poorly. Only use `fyne` or `fyne-cross` after
+running `make generate` first.
+
+xT
+~~
+The Qt Widgets frontend is a separate CMake subproject. It generally supports
+all desktop operating systems. To avoid having to specify the relay address
+each time you run it, pass it on the command line.
+
xW
~~
The Win32 frontend is a separate CMake subproject that should be compiled