update readme
[st.git] / README.md
1 ## st - simple terminal
2 This is pinosaur's patched fork of st from suckless.
3
4 The following patches are applied:
5 - [xresources](https://st.suckless.org/patches/xresources/)
6 - [blinking cursor](https://st.suckless.org/patches/blinking\_cursor/)
7 - [vim browse](https://st.suckless.org/patches/vim\_browse/)
8 - [w3m](https://st.suckless.org/patches/w3m/)
9 - [newterm](https://st.suckless.org/patches/newterm/)
10 - [plumb-keybind](https://gist.githubusercontent.com/MrPicklePinosaur/f393f660223f721b20da561e47c5ae07/raw/774e0339f53665e6a305f1aa69989d694b6cc674/st_simple_plumb_keybind.diff): modified rightclickplumb that allows a key binding to plumb
11
12 ### Requirements
13 In order to build st you need the Xlib header files.
14
15 ### Installation (make)
16 Edit config.mk to match your local setup (st is installed into
17 the /usr/local namespace by default).
18
19 Then run the following:
20 ```
21 make && sudo make clean install
22 ```
23
24 ### Installation (ebuild)
25 For Gentoo users, an ebuild will be up on my website sometime.
26 The `savedconfig` use flag will be available.
27