summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2016-10-30 18:49:07 +0100
committerPřemysl Janouch <p.janouch@gmail.com>2016-10-30 18:52:20 +0100
commit50599e09bd1b079f33a8c522163b3b70a7fa23ff (patch)
tree24c1e363788415378390afad4c9641182962f750 /README.adoc
parentb24bb0aded180f2c7d70ebabbf1ceae6faeece8c (diff)
downloadxK-50599e09bd1b079f33a8c522163b3b70a7fa23ff.tar.gz
xK-50599e09bd1b079f33a8c522163b3b70a7fa23ff.tar.xz
xK-50599e09bd1b079f33a8c522163b3b70a7fa23ff.zip
Update README, add a screenshot for degesch
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
index 5924070..9b211e0 100644
--- a/README.adoc
+++ b/README.adoc
@@ -20,6 +20,8 @@ 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.
+image::degesch.png[align="center"]
+
This is the largest application within the project. It has most of the stuff
you'd expect of an IRC client, such as being able to set up multiple servers,
a powerful configuration system, integrated help, text formatting, CTCP queries,
@@ -142,6 +144,24 @@ Consult the source code and the GNU Readline manual for a list of available
functions. Also refer to the latter for the exact syntax of this file.
Beware that you can easily break the program if you're not careful.
+How do I make degesch look like the screenshot?
+-----------------------------------------------
+First of all, you must build it with Lua support. With the defaults, degesch
+doesn't look very fancy because some things are rather hackish, and I also don't
+want to depend on UTF-8 or 256color terminals in the code. In addition to that,
+I appear to be one of the few people who use black on white terminals.
+
+ /set behaviour.date_change_line = "%a %e %b %Y"
+ /set behaviour.plugin_autoload += "fancy-prompt.lua,thin-cursor.lua"
+ /set behaviour.backlog_helper = "LESSSECURE=1 less -R +Gb -Ps'Backlog ?ltlines %lt-%lb?L/%L. .?e(END):?pB%pB\\%..'"
+ /set behaviour.backlog_helper_strip_formatting = off
+ /set attributes.reset = "\x1b[0m"
+ /set attributes.userhost = "\x1b[38;5;109m"
+ /set attributes.join = "\x1b[38;5;108m"
+ /set attributes.part = "\x1b[38;5;138m"
+ /set attributes.external = "\x1b[38;5;248m"
+ /set attributes.timestamp = "\x1b[48;5;255m\x1b[38;5;250m"
+
Configuration profiles
----------------------
Even though the applications don't directly support configuration profiles,