diff options
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 33 |
1 files changed, 25 insertions, 8 deletions
diff --git a/README.adoc b/README.adoc index 3cfecb7..9ff6785 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,6 +33,11 @@ including link:xC.adoc#_key_bindings[keyboard shortcuts]. image::xP.webp[align="center"] +xA, xT, xW, xM +-------------- +Fyne, Qt Widgets, Win32, Cocoa frontends for 'xC'. +Using them is not recommended. + xD -- The IRC daemon. It is designed for use as a regular user application rather @@ -131,17 +136,29 @@ The precondition for running 'xC' frontends is enabling its relay interface: /set general.relay_bind = "127.0.0.1:9000" -To build the web server, you'll need to install the Go compiler, and run `make` -from the _xP_ directory. Then start it from the _public_ subdirectory, -and navigate to the adress you gave it as its first argument--in the following -example, that would be http://localhost:8080[]: +To build the web server, install the Go compiler, and run `make` +from the _xP_ directory. Then start the resulting binary, and navigate to +the adress you give it as its first argument--in the following example, +that would be http://localhost:8080[]: - $ ../xP 127.0.0.1:8080 127.0.0.1:9000 + $ ./xP 127.0.0.1:8080 127.0.0.1:9000 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 |