p/xK
1
1
Fork 0
Code Issues 1 Pull Requests Releases 11 Wiki Activity

Fix up README

Browse Source
This commit is contained in:
Přemysl Eric Janouch 2022-09-05 14:58:44 +02:00
parent 1639235a48
commit e250ae8255
Signed by: p
GPG Key ID: A0420B94F92B9493
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.adoc
View File

@ -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. certificates, a remote relay interface, or basic support for Lua scripting.
As a unique bonus, you can launch a full text editor from within. 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 xP
-- --
The web frontend for 'xC', making use of its networked relay interface. 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 xD
-- --
@ -72,15 +73,15 @@ Building
Build-only dependencies: Build-only dependencies:
CMake, pkg-config, asciidoctor or asciidoc, awk, liberty (included) + CMake, pkg-config, asciidoctor or asciidoc, awk, liberty (included) +
Common runtime dependencies: openssl + Common runtime dependencies: openssl +
Additionally for 'xC': curses, libffi, + Additionally for 'xC': curses, libffi, readline >= 6.0 or libedit >= 2013-07-12,
readline >= 6.0 or libedit >= 2013-07-12, lua >= 5.3 (optional) + lua >= 5.3 (optional) +
Additionally for 'xF': x11, xft Additionally for 'xF': x11, xft
$ git clone --recursive https://git.janouch.name/p/xK.git $ git clone --recursive https://git.janouch.name/p/xK.git
$ mkdir xK/build $ mkdir xK/build
$ cd xK/build $ cd xK/build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=RelWithDebInfo \ $ 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 $ make
To install the application, you can do either the usual: To install the application, you can do either the usual: