st

commit d752ebc0a4b58bf818bf5aefe3757b83af2a996b
parent 324d464f113940b335e9ed55392886c313c29883
Author: sioodmy <sioodmy@tuta.io>
Date:   Tue, 19 Jul 2022 22:02:01 +0200

docs: add nix

Diffstat:
M
README.md
 | 
32
+++++++++++++++++++++++---------

1 file changed, 23 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
@@ -7,29 +7,42 @@
 ## Dependencies
 
 ```
-# Void 
+# 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 
+apt install build-essential libxft-dev libharfbuzz-dev
+
+# Nix
+nix develop github:siduck/st
 
 (most of these are already installed on Arch based distros)
 
 # Install font-symbola and libXft-bgra
 ```
 
+## Try it out!
+
+Before you install st on your system, you might want to try it out first.
+To do so, simply run (requires [Nix](https://nixos.org/download.html))
+`nix run github:siduck/st`
+
 ## Install
 
 ```
 git clone https://github.com/siduck/st.git
 cd st
-sudo make install 
+sudo make install
 xrdb merge pathToXresourcesFile
 ```
 
-(note : put the xrdb merge command in your wm's autostart or similar) 
+(note : put the xrdb merge command in your wm's autostart or similar)
 
-## Fonts 
+### Using Nix flakes
+
+Add `st.url = "github:siduck/st";` to your inputs and install `inputs.st.packages."${system}".st-snazzy` package
+
+## Fonts
 
 - Install JetbrainsMono Mono Nerd Font or any nerd font from [here](https://www.nerdfonts.com/font-downloads)
 
@@ -62,6 +75,7 @@ alias rel="xrdb merge pathToXresourcesFile && kill -USR1 $(pidof st)"
 ```
 
 ## Ram usage comparison with other terminals and speed test
+
 <img src="https://raw.githubusercontent.com/siduck/dotfiles/all/rice%20flex/terminal_ramUsage.jpg"> <br><br>
 <img src="https://raw.githubusercontent.com/siduck/dotfiles/all/rice%20flex/speedTest.png"> <br><br>
 <img src="https://raw.githubusercontent.com/siduck/dotfiles/all/rice%20flex/speedTest1.png"> <br><br>
@@ -73,7 +87,7 @@ alias rel="xrdb merge pathToXresourcesFile && kill -USR1 $(pidof st)"
 <pre>
 ctrl + shift + c        Copy  <br>
 ctrl + shift + v        Paste <br>
-right click on the terminal ( will paste the copied thing ) 
+right click on the terminal ( will paste the copied thing )
 
 (Zoom)
 alt  + comma            Zoom in <br>
@@ -85,7 +99,7 @@ alt  + s                Increase Transparency<br>
 alt  + a                Decrease Transparency<br>
 alt  + m                Reset Transparency<br>
 
-alt + k                 scroll down 
+alt + k                 scroll down
 alt + j                 scroll up
 
 mod + shift + enter    open a new terminal with same cwd ( current working directory )
@@ -109,5 +123,5 @@ you can change all of these in config.h
 
 # Credits
 
-- [live-reload](https://github.com/nimaipatel/st) 
+- [live-reload](https://github.com/nimaipatel/st)
 - [patch_column](https://github.com/nimaipatel/st/blob/all/patches/7672445bab01cb4e861651dc540566ac22e25812.diff)