From 066ce9d056e6635479e4003d3300c67c57362b8c Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Mon, 3 Feb 2025 10:53:33 +0530 Subject: [PATCH] Note that when using ./dev/sh on Linux the X11 development libraries must be installed Fixes #8280 --- docs/build.rst | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/docs/build.rst b/docs/build.rst index 90685db55..41dcd0454 100644 --- a/docs/build.rst +++ b/docs/build.rst @@ -13,7 +13,8 @@ Build from source |kitty| is designed to run from source, for easy hack-ability. All you need to get started is a C compiler and the `go compiler -`__. After installing those, run the following commands:: +`__ (on Linux, the :ref:`X11 development libraries ` as well). +After installing those, run the following commands:: git clone https://github.com/kovidgoyal/kitty.git && cd kitty ./dev.sh build @@ -109,19 +110,25 @@ Build-time dependencies: your distro: - ``libdbus-1-dev`` + - ``liblcms2-dev`` + - ``libfontconfig-dev`` + - ``libssl-dev`` + - ``libpython3-dev`` + - ``libxxhash-dev`` + - ``libsimde-dev`` + + .. _x11-dev-libs: + + Also, the X11 development libraries: + - ``libxcursor-dev`` - ``libxrandr-dev`` - ``libxi-dev`` - ``libxinerama-dev`` - ``libgl1-mesa-dev`` - ``libxkbcommon-x11-dev`` - - ``libfontconfig-dev`` - ``libx11-xcb-dev`` - - ``liblcms2-dev`` - - ``libssl-dev`` - - ``libpython3-dev`` - - ``libxxhash-dev`` - - ``libsimde-dev`` + Build and run from source with Nix