summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorPřemysl Eric Janouch <p@janouch.name>2022-09-05 14:58:44 +0200
committerPřemysl Eric Janouch <p@janouch.name>2022-09-05 23:07:19 +0200
commite250ae8255c9d60c406f8bdd64b321df94bba3e9 (patch)
treeed41275e01092f5ccbdcef11bbe6da330ac36e48 /README.adoc
parent1639235a48dbed75c2563c9a497b41c31a2a1bae (diff)
downloadxK-e250ae8255c9d60c406f8bdd64b321df94bba3e9.tar.gz
xK-e250ae8255c9d60c406f8bdd64b321df94bba3e9.tar.xz
xK-e250ae8255c9d60c406f8bdd64b321df94bba3e9.zip
Fix up README
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc19
1 files 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: