aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: b068ecc1b95db26b96c31179e7cf8807e46dd8fc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# A personal fork of st - the suckless terminal

## Patches

Look at the commit history for more details on how/why these patches
were applied.

+ [font2](https://st.suckless.org/patches/font2/) - allows the
  definition of fallback fonts;
+ [desktopentry](https://st.suckless.org/patches/desktopentry/) - add
  desktop entry during installation;
+ [scrollback](https://st.suckless.org/patches/scrollback/) - enables
  buffer scrollback.
+ [boxdraw](https://st.suckless.org/patches/boxdraw/) - handles
  line/box/braille drawings
+ [ligatures](https://st.suckless.org/patches/ligatures/) - add ligature
  support

Requirements
------------
In order to build st you need the Xlib header files.

Installation
------------
Edit config.mk to match your local setup (st is installed into
the /usr/local namespace by default).

Afterwards enter the following command to build and install st (if
necessary as root):

    make clean install


Running st
----------
If you did not install st with make clean install, you must compile
the st terminfo entry with the following command:

    tic -sx st.info

See the man page for additional details.

Credits
-------
Based on Aurélien APTEL <aurelien dot aptel at gmail dot com> bt source code.