diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 474f6cf3c..4666f1eac 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -25,6 +25,10 @@ pre { white-space: pre-wrap; } +pre.pre { + white-space: pre; +} + a[href], input[type="submit"] { cursor: pointer; } img[style] { diff --git a/docs/binary.rst b/docs/binary.rst new file mode 100644 index 000000000..4b92ffd04 --- /dev/null +++ b/docs/binary.rst @@ -0,0 +1,65 @@ +kitty - Binary install +======================== + +.. |ins| replace:: curl -L :file:`https://sw.kovidgoyal.net/kitty/installer.sh` | sh /dev/stdin + +.. highlight:: sh + +You can install pre-built binaries of |kitty| if you are on macOS or Linux using +the following simple command: + +.. parsed-literal:: + :class: pre + + |ins| + + +The binaries will be installed in the standard location for your OS, +:file:`/Applications/kitty.app` on macOS and :file:`~/.local/kitty.app` on +Linux. The installer only touches files in that directory. + + +Customizing the installation +-------------------------------- + +* You can specify a different install location, with ``dest``: + + .. parsed-literal:: + :class: pre + + |ins| \\ + dest=/some/other/location + +* You can tell the installer not to launch |kitty| after installing it with + ``launch=n``: + + .. parsed-literal:: + :class: pre + + |ins| \\ + launch=n + +* You can use a previously downloaded dmg/tarball, with ``installer``: + + .. parsed-literal:: + :class: pre + + |ins| \\ + installer=/path/to/dmg or tarball + + +Manually installing +--------------------- + +If something goes wrong or you simply do not want to run the installer, you can +manually download and install |kitty| from the `GitHub releases page +`_. If you are on macOS, download +the :file:`.dmg` and install as normal. If you are on Linux, download the tarball +and extract it into a directory. The |kitty| executable will be in the +:file:`bin` sub-directory. + + +Building from source +------------------------ + +|kitty| is easy to build from source, follow the :doc:`instructions `.