diff options
| author | Přemysl Eric Janouch <p@janouch.name> | 2022-08-08 04:39:20 +0200 |
|---|---|---|
| committer | Přemysl Eric Janouch <p@janouch.name> | 2022-09-05 14:26:00 +0200 |
| commit | 1639235a48dbed75c2563c9a497b41c31a2a1bae (patch) | |
| tree | 18193b72fa47e6bcac1358289ac9c36ed00c70ac /README.adoc | |
| parent | 2160d037943ef0a3adbf4c6e30a91ee0f205c3f3 (diff) | |
| download | xK-1639235a48dbed75c2563c9a497b41c31a2a1bae.tar.gz xK-1639235a48dbed75c2563c9a497b41c31a2a1bae.tar.xz xK-1639235a48dbed75c2563c9a497b41c31a2a1bae.zip | |
Start X11 and web frontends for xC
For this, we needed a wire protocol. After surveying available options,
it was decided to implement an XDR-like protocol code generator
in portable AWK. It now has two backends, per each of:
- xF, the X11 frontend, is in C, and is meant to be the primary
user interface in the future.
- xP, the web frontend, relies on a protocol proxy written in Go,
and is meant for use on-the-go (no pun intended).
They are very much work-in-progress proofs of concept right now,
and the relay protocol is certain to change.
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 36 |
1 files changed, 23 insertions, 13 deletions
diff --git a/README.adoc b/README.adoc index 11eb609..559c69d 100644 --- a/README.adoc +++ b/README.adoc @@ -1,9 +1,9 @@ xK == -'xK' (chat kit) is an IRC software suite consisting of a terminal client, -daemon, and bot. It's all you're ever going to need for chatting, -so long as you can make do with slightly minimalist software. +'xK' (chat kit) is an IRC software suite consisting of a daemon, bot, terminal +client, and X11/web 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. @@ -20,8 +20,18 @@ a powerful configuration system, integrated help, text formatting, automatic message splitting, multiline editing, bracketed paste support, word wrapping that doesn't break links, autocomplete, logging, CTCP queries, auto-away, command aliases, SOCKS proxying, SASL EXTERNAL authentication using TLS client -certificates, or basic support for Lua scripting. As a unique bonus, you can -launch a full text editor from within. +certificates, a remote relay interface, or basic support for Lua scripting. +As a unique bonus, you can launch a full text editor from within. + +xF +-- +The X11 frontend for 'xC', making use of its networked relay interface. +It's currently in development, and is hidden behind a CMake option. + +xP +-- +The web frontend for 'xC', making use of its networked relay interface. +It's currently rather elementary, and can be built from within its directory. xD -- @@ -38,9 +48,8 @@ What it notably doesn't support is online changes to configuration, any limits besides the total number of connections and mode `+l`, or server linking (which also means no services). -This program has been -https://git.janouch.name/p/haven/src/branch/master/hid[ported to Go], -and development continues over there. +This program has been https://git.janouch.name/p/haven/src/branch/master/hid[ +ported to Go] in a different project, and development continues over there. xB -- @@ -60,11 +69,12 @@ a package with the latest development version from Archlinux's AUR. Building -------- -Build dependencies: CMake, pkg-config, asciidoctor or asciidoc, awk, - liberty (included) + -Runtime dependencies: openssl + -Additionally for 'xC': curses, libffi, lua >= 5.3 (optional), - readline >= 6.0 or libedit >= 2013-07-12 +Build-only dependencies: + CMake, pkg-config, asciidoctor or asciidoc, awk, liberty (included) + +Common runtime dependencies: openssl + +Additionally for 'xC': curses, libffi, + + readline >= 6.0 or libedit >= 2013-07-12, lua >= 5.3 (optional) + +Additionally for 'xF': x11, xft $ git clone --recursive https://git.janouch.name/p/xK.git $ mkdir xK/build |