commit 0722e56b2b5e7d45c8602c517f08b81b8c553d2f
parent 4c344527698fd0424ad025e0e61ed5b311045b39
Author: siduck76 <siduckk76@protonmail.com>
Date: Tue, 28 Sep 2021 09:41:25 +0530
clean and improve readme
Diffstat:
| M | README.md | | | 127 | ++++++++++++++++++++++++++++++++++++++++--------------------------------------- |
1 file changed, 65 insertions(+), 62 deletions(-)
diff --git a/README.md b/README.md
@@ -1,4 +1,37 @@
-# st (Suckless Terminal)
+# St (Suckless Terminal)
+
+## Xresources live-reload demo
+
+<img src="https://github.com/siduck76/dotfiles/blob/all/rice%20flex/live-reloadXresources.gif"> <br><br>
+
+## 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...
<br>
-## 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
-
-<img src="https://github.com/siduck76/dotfiles/blob/master/rice%20flex/live-reloadXresources.gif"> <br><br>
-<b>DON'T SKIP THE README, if you want to have a similar setup / know default keybinds.<br><br></b>
+## Ram usage comparison with other terminals and speed test
+<img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/terminal_ramUsage.jpg"> <br><br>
+<img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/speedTest.png"> <br><br>
+<img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/speedTest1.png"> <br><br>
-## Dependencies : <br>
-
-```
-
-#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 <br>
-
-`cd st (this repo) `<br>
-`sudo make install `<br>
-
-(note : dont forget do run the xrdb merge xresourcesfile command , put that in your wm's autostart or such)
-
-## other ST builds <br>
-
-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
-<img src="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/terminal_ramUsage.jpg"> <br><br>
-<img src="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/speedTest.png"> <br><br>
-<img src="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/speedTest1.png"> <br><br>
-
-( 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<br>
<pre>
ctrl + shift + c Copy <br>
ctrl + shift + v Paste <br>
+right click on the terminal ( will paste the copied thing )
+
+(Zoom)
alt + comma Zoom in <br>
alt + . Zoom out <br>
alt + g Reset Zoom<br>
+
+(Transparency)
alt + s Increase Transparency<br>
alt + a Decrease Transparency<br>
alt + m Reset Transparency<br>
-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 )
</pre>
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 <br>
- Xresources: onedark ( just xrdb merge xresourcesfile , do this everytime you make any change to xresources file ) from this repo itself.<br>
-- Font: <a href="https://github.com/siduck76/matfonts"> JetbrainsMono Nerd Font + material design icon fonts </a>
-
-a lil<a href="https://share.vidyard.com/watch/sdFeoxaRr124U893WVEcxN?"> video </a>demo to show zoom/alpha changing via keybinds
+- Font: JetbrainsMono Nerd Font + material design icon fonts
## Screenshots:
-<img src="https://raw.githubusercontent.com/siduck76/personal-backup/master/misc/delete_this/bruh.png"> <br><br>
-<img src="https://raw.githubusercontent.com/siduck76/personal-backup/master/misc/delete_this/ithree0-36-43.png"> <br><br>
-<img src="https://raw.githubusercontent.com/siduck76/personal-backup/master/misc/delete_this/two7-00.png"> <br><br>
-<img src="https://raw.githubusercontent.com/siduck76/personal-backup/master/misc/delete_this/u.png"> <br><hr>
+<img src="https://raw.githubusercontent.com/siduck76/personal-backup/all/misc/delete_this/bruh.png"> <br><br>
+<img src="https://raw.githubusercontent.com/siduck76/personal-backup/all/misc/delete_this/ithree0-36-43.png"> <br><br>
+<img src="https://raw.githubusercontent.com/siduck76/personal-backup/all/misc/delete_this/two7-00.png"> <br><br>
+<img src="https://raw.githubusercontent.com/siduck76/personal-backup/all/misc/delete_this/u.png"> <br><hr>
# 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 <br>
+
+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`
