summaryrefslogtreecommitdiffstats
path: root/system/kitty-bin/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/kitty-bin/README')
-rw-r--r--system/kitty-bin/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/system/kitty-bin/README b/system/kitty-bin/README
new file mode 100644
index 0000000000..64dc5136a8
--- /dev/null
+++ b/system/kitty-bin/README
@@ -0,0 +1,21 @@
+kitty-bin (fast, featureful, GPU-based terminal emulator)
+
+kitty is a terminal emulator for X11 and Wayland [1], which offloads
+the rendering to the GPU [2] and supports modern terminal features. It
+also supports tiling multiple terminal windows without using an extra
+program like screen or tmux.
+
+This conflicts with system/kitty. Do not install kitty-bin and kitty
+on the same system.
+
+This build packages the official kitty binaries for Linux. If you'd
+rather build from source, you can install system/kitty instead, but be
+aware that kitty-bin will usually be a newer version of kitty.
+
+[1] For Wayland support, it may be necessary to add the following
+ line to ~/.config/kitty/kitty.conf:
+ linux_display_server wayland
+
+[2] Requires hardware-accelerated OpenGL support.
+
+See README.aarch64 if you're using 64-bit ARM.