diff options
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ebd6454 --- /dev/null +++ b/README.md @@ -0,0 +1,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). |