summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc19
1 files changed, 15 insertions, 4 deletions
diff --git a/README.adoc b/README.adoc
index 4a82d33..6784e84 100644
--- a/README.adoc
+++ b/README.adoc
@@ -2,8 +2,9 @@ xK
==
'xK' (chat kit) is an IRC software suite consisting of a daemon, bot, terminal
-client, and web + Win32 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.
+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.
They're all lean on dependencies, and offer a maximally permissive licence.
@@ -140,13 +141,23 @@ endpoint as the third command line argument in this case.
xW
~~
The Win32 frontend is a separate CMake subproject that should be compiled
-using MinGW-w64. In order to run it, make a shortcut for the executable and
-include the relay address in its _Target_ field:
+using MinGW-w64. To avoid having to specify the relay address each time you
+run it, create a shortcut for the executable and include the address in its
+_Target_ field:
C:\...\xW.exe 127.0.0.1 9000
It works reasonably well starting with Windows 7.
+xM
+~~
+The Cocoa frontend is a separate CMake subproject that requires Xcode to build.
+It is currently not that usable. The relay address can either be passed on
+the command line, or preset in the _defaults_ database:
+
+ $ defaults write name.janouch.xM relayHost 127.0.0.1
+ $ defaults write name.janouch.xM relayPort 9000
+
Client Certificates
-------------------
'xC' will use the SASL EXTERNAL method to authenticate using the TLS client