aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: ebd6454cfb5d0cc18484681393ca071f37c087ba (plain)
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
# swt - simple wayland terminal

This is a fork of st and is a simple terminal emulator for Wayland which sucks less.

## Requirements
In order to build swt you need the wayland-client and -protocols, freetype2 and xkbcommon.

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

Afterwards enter the following command to build and install swt
(if necessary as root):
```sh
make clean install
```

## Running swt
If you did not install swt with make clean install you must compile the swt terminfo entry with the following command:
```
tic -sx swt.info
```

## Credits
Shout-outs to the suckless team for the implementation of st on the X side.
For more information see (https://suckless.org).