mirror of
https://github.com/kovidgoyal/kitty
synced 2026-07-26 02:02:14 +02:00
Some more docs
This commit is contained in:
33
README.md
33
README.md
@@ -5,7 +5,7 @@ kitty - A terminal emulator
|
||||
|
||||
Major features:
|
||||
|
||||
* Uses OpenGL+FreeType for rendering
|
||||
* Uses OpenGL+FreeType for rendering, does not depend on any GUI toolkits.
|
||||
* Supports tiling multiple terminal windows side by side in different layouts
|
||||
without needing to use an extra program like tmux
|
||||
* Supports all modern terminal features: unicode, true-color, mouse protocol,
|
||||
@@ -17,6 +17,37 @@ Major features:
|
||||
not occur. The downside is that scripts with complex glyph layout, such as
|
||||
Arabic do not render well.
|
||||
|
||||
Installation
|
||||
--------------
|
||||
|
||||
kitty is designed to run from source, for easy hackability. Make sure the
|
||||
following dependencies are installed first:
|
||||
|
||||
* python >= 3.5
|
||||
* glew >= 2.0
|
||||
* glfw-dev >= 3.2
|
||||
* freetype
|
||||
* fontconfig
|
||||
* gcc (required for building, clang should also work, but it is not tested)
|
||||
* pkg-config (required for building)
|
||||
|
||||
Now build the C parts of kitty with the following command:
|
||||
|
||||
python3 setup.py build
|
||||
|
||||
You can run kitty, as:
|
||||
|
||||
python3 /path/to/kitty/folder
|
||||
|
||||
Configuration
|
||||
---------------
|
||||
|
||||
kitty is highly customizable, everything from keyboard shortcuts, to painting
|
||||
frames-per-second. See the heavily commented [default config file](kitty/kitty.conf).
|
||||
By default kitty looks for a config file in the OS
|
||||
config directory (usually `~/.config/kitty/kitty.conf` on linux) but you can pass
|
||||
a specific path via the `--config` option.
|
||||
|
||||
|
||||
Resources on terminal behavior
|
||||
------------------------------------------
|
||||
|
||||
Reference in New Issue
Block a user