From e250ae8255c9d60c406f8bdd64b321df94bba3e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Eric=20Janouch?= Date: Mon, 5 Sep 2022 14:58:44 +0200 Subject: [PATCH] Fix up README --- README.adoc | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.adoc b/README.adoc index 559c69d..37ebbb9 100644 --- a/README.adoc +++ b/README.adoc @@ -23,15 +23,16 @@ command aliases, SOCKS proxying, SASL EXTERNAL authentication using TLS client 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. +So far it's quite basic, yet usable. Build it using `make` in its directory, +and run it from within the _public_ subdirectory. + +xF +-- +The X11 frontend for 'xC', making use of its networked relay interface. +It's currently in development, and hidden behind a CMake option. xD -- @@ -72,15 +73,15 @@ Building 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 '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 $ cd xK/build $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=RelWithDebInfo \ - -DWANT_READLINE=ON -DWANT_LIBEDIT=OFF -DWANT_LUA=ON + -DWANT_READLINE=ON -DWANT_LIBEDIT=OFF -DWITH_LUA=ON $ make To install the application, you can do either the usual: