summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorPřemysl Eric Janouch <p@janouch.name>2022-08-07 10:40:42 +0200
committerPřemysl Eric Janouch <p@janouch.name>2022-08-07 10:40:42 +0200
commitef0cbe9a596a8c251d451a1b54858c9a1e988bf9 (patch)
tree78c22eb3637beb69e3198170bdb74892f43e522e /README.adoc
parent2d8808d795901c2ef733072b48dfa7356de528a9 (diff)
downloadxK-ef0cbe9a596a8c251d451a1b54858c9a1e988bf9.tar.gz
xK-ef0cbe9a596a8c251d451a1b54858c9a1e988bf9.tar.xz
xK-ef0cbe9a596a8c251d451a1b54858c9a1e988bf9.zip
Rename the project
It is about to see some extensions, obsoleting the number three.
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc40
1 files changed, 20 insertions, 20 deletions
diff --git a/README.adoc b/README.adoc
index ffeced7..ea378be 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,11 +1,11 @@
-uirc3
-=====
+xK
+==
-The unreasonable IRC trinity. This project consists of an IRC client, daemon,
-and bot. It's all you're ever going to need for chatting, as long as you can
-make do with minimalist software.
+'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.
-They have these potentially interesting properties:
+They come with these potentially interesting properties:
- supporting IRCv3, SOCKS, IPv6, TLS (including client certificates)
- lean on dependencies
@@ -14,18 +14,18 @@ They have these potentially interesting properties:
xC
--
-The IRC client. It is largely defined by being built on top of GNU Readline
-that has been hacked to death. Its interface should feel somewhat familiar for
-weechat or irssi users.
+The IRC client, and the core of 'xK'. It is largely defined by being built
+on top of GNU Readline that has been hacked to death. Its interface should feel
+somewhat familiar for weechat or irssi users.
image::xC.png[align="center"]
-This is the core of the project. It has most of the stuff you'd expect of
-an IRC client, such as being multiserver, a powerful configuration system,
-integrated help, text formatting, automatic splitting of overlong messages,
-multiline editing, bracketed paste support, decent word wrapping, autocomplete,
-logging, CTCP queries, auto-away, command aliases, and basic support for Lua
-scripting. As a unique bonus, you can launch a full text editor from within.
+It has most of the stuff you'd expect of an IRC client, such as being
+multiserver, a powerful configuration system, integrated help, text formatting,
+automatic splitting of overlong messages, multiline editing, bracketed paste
+support, decent word wrapping, autocomplete, logging, CTCP queries, auto-away,
+command aliases, and basic support for Lua scripting. As a unique bonus,
+you can launch a full text editor from within.
xD
--
@@ -79,9 +79,9 @@ Additionally for 'xC': curses, libffi, lua >= 5.3 (optional),
Avoid libedit if you can, in general it works but at the moment history is
acting up and I have no clue about fixing it.
- $ git clone --recursive https://git.janouch.name/p/uirc3.git
- $ mkdir uirc3/build
- $ cd uirc3/build
+ $ 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
$ make
@@ -93,7 +93,7 @@ To install the application, you can do either the usual:
Or you can try telling CMake to make a package for you:
$ cpack -G DEB # also supported: RPM, FreeBSD
- # dpkg -i uirc3-*.deb
+ # dpkg -i xK-*.deb
Usage
-----
@@ -179,7 +179,7 @@ configurations accordingly, but I consider it rather messy and unnecessary.
Contributing and Support
------------------------
-Use https://git.janouch.name/p/uirc3 to report any bugs, request features,
+Use https://git.janouch.name/p/xK to report any bugs, request features,
or submit pull requests. `git send-email` is tolerated. If you want to discuss
the project, feel free to join me at ircs://irc.janouch.name, channel #dev.