From 0722e56b2b5e7d45c8602c517f08b81b8c553d2f Mon Sep 17 00:00:00 2001 From: siduck76 Date: Tue, 28 Sep 2021 09:41:25 +0530 Subject: [PATCH] clean and improve readme --- README.md | 127 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 65 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index 2d829e1fdf102fdafeed83f51910bf93a4245dde..99746ef08a93800374eee4f23755739622f672f1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,37 @@ -# st (Suckless Terminal) +# St (Suckless Terminal) + +## Xresources live-reload demo + +

+ +## Dependencies + +``` +# Void +xbps-install libXft-devel libX11-devel harfbuzz-devel libXext-devel libXrender-devel libXinerama-devel + +# Debian (and ubuntu probably) +apt install build-essential libxft-dev libharfbuzz-dev + +(most of these are already installed on Arch based distros) + +# Install font-symbola too +``` + +## Install + +``` +git clone https://github.com/siduck76/st.git +cd st +sudo make install +xrdb merge pathToXresourcesFile +``` + +(note : put the xrdb merge command in your wm's autostart or similar) + +## Fonts + +- Install JetbrainsMono Mono Nerd Font or any nerd font from [here](https://www.nerdfonts.com/font-downloads) ## Patches: @@ -21,79 +54,42 @@ and more...
-## Fonts - -- Install JetbrainsMono Mono Nerd Font or any nerd font from [here](https://www.nerdfonts.com/font-downloads) - -## How to apply Xresources and live-reload ? +## Xresources live-reload ``` - #make an alias for this command - -alias load="kill -USR1 $(pidof st)" -alias use="xrdb merge" - -command : use Xresourcesfile && load +# make an alias for this command +alias rel="xrdb merge pathToXresourcesFile && kill -USR1 $(pidof st)" ``` -## Xresources live-reload demo - -

-DON'T SKIP THE README, if you want to have a similar setup / know default keybinds.

 +## Ram usage comparison with other terminals and speed test +

+

+

-## Dependencies :
- -``` - -#void (most of these are already installed on arch distros) -xbps-install libXft-devel libX11-devel harfbuzz-devel libXext-devel libXrender-devel libXinerama-devel - -#Debian (and ubuntu probably) -apt install build-essential libxft-dev libharfbuzz-dev - -# Install font-symbola too -``` - -## Install
- -`cd st (this repo) `
-`sudo make install `
- -(note : dont forget do run the xrdb merge xresourcesfile command , put that in your wm's autostart or such) - -## other ST builds
- -1. Default ST (main branch) -2. Sixel St (sixel branch , with sixel graphics support) -3. St with vim-browse (vim-browse branch , navigate within like vim) - -- Use a different st build ( clone its branch) - -`example: git clone https://github.com/siduck76/st --branch sixel` - -## Ram comparison with other terminals and speed test -

-

-

- -( note : This benchmark was done on my low end machine which has a pentium cpu so the results might vary ) +( note : This benchmark was done on my low end machine which has a pentium cpu so the speed results might vary ) ## Default Keybindings
 ctrl + shift + c        Copy  

 ctrl + shift + v        Paste 

+right click on the terminal ( will paste the copied thing ) 
+
+(Zoom)
 alt  + comma            Zoom in 

 alt  + .                Zoom out 

 alt  + g                Reset Zoom

+
+(Transparency)
 alt  + s                Increase Transparency

 alt  + a                Decrease Transparency

 alt  + m                Reset Transparency

-copy anything and right click on the terminal ( will paste the copied thing ) 
-mod + shift + enter    open a new terminal with same cwd ( current working directory )
+
 alt + k                 scroll down 
 alt + j                 scroll up
+
+mod + shift + enter    open a new terminal with same cwd ( current working directory )
you can change all of these in config.h @@ -103,18 +99,25 @@ you can change all of these in config.h - ls-icons: https://github.com/Yash-Handa/logo-ls
- Xresources: onedark ( just xrdb merge xresourcesfile , do this everytime you make any change to xresources file ) from this repo itself.
-- Font: JetbrainsMono Nerd Font + material design icon fonts - -a lil video demo to show zoom/alpha changing via keybinds +- Font: JetbrainsMono Nerd Font + material design icon fonts ## Screenshots: -

-

-

-
+

+

+

+
# Credits - [live-reload](https://github.com/nimaipatel/st) -- [patch_column](https://github.com/nimaipatel/st/blob/master/patches/7672445bab01cb4e861651dc540566ac22e25812.diff) +- [patch_column](https://github.com/nimaipatel/st/blob/all/patches/7672445bab01cb4e861651dc540566ac22e25812.diff) + +## Other St builds
+ +1. Sixel St (sixel branch , with sixel graphics support) +2. St with vim-browse (vim-browse branch , navigate within like vim) + +- Use a different st build ( clone its branch) + +`example: git clone https://github.com/siduck76/st --branch sixel`