diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 74 |
1 files changed, 27 insertions, 47 deletions
@@ -1,54 +1,34 @@ st - simple terminal -==================== +-------------------- +st is a simple terminal emulator for X which sucks less. -Introduction + +Requirements ------------ -This is my personnal build of st, a simple terminal emulator for X -which sucks less. I've applied some patches. +In order to build st you need the Xlib header files. -Depedencies ------------ - - A C compiler - - xorg - - make Installation ------------ -To install this build, run these commands: - - $ git clone git://jozanleclerc.xyz/jozan/st.git - $ cd st - $ make - # make install clean - -It is installed by default in the user /usr/local/bin directory but you can -change it to something that matches more your $PATH by editing the PREFIX -variable in config.mk. - -Applied patches ---------------- -You can find a list of patches and check what those I've applied are -doing on st's patches page. - -Here is my list: - - anygeometry - - bold is not bright - - clipboard - - externalpipe - - hidecursor - - keyboard select - - scrollback - -Settings --------- -Most settings are done by editing config.h and recompiling. - - Fonts - ----- - The default font is part of the Nerd Fonts collection but can - be changed in config.h:19. - - Colors - ------ - The colorscheme used in this build is gruvbox dark hard, you can - change it at config.h:110. +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. + |