aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTyler Hoang <tyler@tylerhoang.xyz>2021-11-06 21:02:26 -0700
committerTyler Hoang <tyler@tylerhoang.xyz>2021-11-06 21:02:26 -0700
commite8e1c62ce069e6f5a1ede5cd2d7824cb7492583f (patch)
tree621f87a4979636d4ae5901542dce483406894058 /README.md
parent072e1764185eb5f9e60414dda41194d09d2bdf38 (diff)
updated
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 38 insertions, 20 deletions
diff --git a/README.md b/README.md
index a8d44d8..c410e4b 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-# Tyler's build of st - the simple (suckless) terminal
-This is basically the same thing as Luke Smith's [st build](https://github.com/LukeSmithxyz/st) with some settings that work better for me
+# Luke's build of st - the simple (suckless) terminal
-The [suckless terminal (st)](https://st.suckless.org/) with some additional features that make it literally the best terminal emulator ever:
+The [suckless terminal (st)](https://st.suckless.org/) with some additional
+features that make it literally the best terminal emulator ever:
## Unique features (using dmenu)
@@ -11,9 +11,12 @@ The [suckless terminal (st)](https://st.suckless.org/) with some additional feat
## Bindings for
-+ **scrollback** with `alt-↑/↓` or `alt-pageup/down` or `shift` while scrolling the mouse
-+ OR **vim-bindings**: scroll up/down in history with `alt-k` and `alt-j`. Faster with `alt-u`/`alt-d`.
-+ **zoom/change font size**: same bindings as above, but holding down shift as well. `alt-home` returns to default
++ **scrollback** with `alt-↑/↓` or `alt-pageup/down` or `shift` while scrolling the
+ mouse.
++ OR **vim-bindings**: scroll up/down in history with `alt-k` and `alt-j`.
+ Faster with `alt-u`/`alt-d`.
++ **zoom/change font size**: same bindings as above, but holding down shift as
+ well. `alt-home` returns to default
+ **copy text** with `alt-c`, **paste** is `alt-v` or `shift-insert`
## Pretty stuff
@@ -21,32 +24,42 @@ The [suckless terminal (st)](https://st.suckless.org/) with some additional feat
+ Compatibility with `Xresources` and `pywal` for dynamic colors.
+ Default [gruvbox](https://github.com/morhetz/gruvbox) colors otherwise.
+ Transparency/alpha, which is also adjustable from your `Xresources`.
-+ Default font is system "mono" at 14pt, meaning the font will match your system font.
++ Default font is system "mono" at 14pt, meaning the font will match your
+ system font.
## Other st patches
-+ Vertcenter
-+ Scrollback
++ Boxdraw
++ Ligatures
+ font2
-+ updated to latest version 0.8.2
++ updated to latest version 0.8.4
## Installation for newbs
+You should have xlib header files and libharfbuzz build files installed.
+
```
-git clone https://github.com/tyhoang/st
+git clone https://github.com/LukeSmithxyz/st
cd st
sudo make install
```
-Obviously, `make` is required to build. `fontconfig` is required for the default build, since it asks `fontconfig` for your system monospace font. It might be obvious, but `libX11` and `libXft` are required as well. Chances are, you have all of this installed already.
+Obviously, `make` is required to build. `fontconfig` is required for the
+default build, since it asks `fontconfig` for your system monospace font. It
+might be obvious, but `libX11` and `libXft` are required as well. Chances are,
+you have all of this installed already.
-On OpenBSD, be sure to edit `config.mk` first and remove `-lrt` from the `$LIBS` before compiling.
+On OpenBSD, be sure to edit `config.mk` first and remove `-lrt` from the
+`$LIBS` before compiling.
-Be sure to have a composite manager (`xcompmgr`, `picom`, etc.) running if you want transparency.
+Be sure to have a composite manager (`xcompmgr`, `picom`, etc.) running if you
+want transparency.
## How to configure dynamically with Xresources
-For many key variables, this build of `st` will look for X settings set in either `~/.Xdefaults` or `~/.Xresources`. You must run `xrdb` on one of these files to load the settings.
+For many key variables, this build of `st` will look for X settings set in
+either `~/.Xdefaults` or `~/.Xresources`. You must run `xrdb` on one of these
+files to load the settings.
For example, you can define your desired fonts, transparency or colors:
@@ -57,7 +70,8 @@ For example, you can define your desired fonts, transparency or colors:
...
```
-The `alpha` value (for transparency) goes from `0` (transparent) to `1` (opaque).
+The `alpha` value (for transparency) goes from `0` (transparent) to `1`
+(opaque). There is an example `Xdefaults` file in this respository.
### Colors
@@ -71,11 +85,15 @@ Note that when you run `wal`, it will negate the transparency of existing window
## Notes on Emojis and Special Characters
-If st crashes when viewing emojis, install [libxft-bgra](https://aur.archlinux.org/packages/libxft-bgra/) from the AUR.
+If st crashes when viewing emojis, install
+[libxft-bgra](https://aur.archlinux.org/packages/libxft-bgra/) from the AUR.
-Note that some special characters may appear truncated if too wide. You might want to manually set your prefered emoji/special character font to a lower size in the `config.h` file to avoid this. By default, JoyPixels is used at a smaller size than the usual text.
+Note that some special characters may appear truncated if too wide. You might
+want to manually set your prefered emoji/special character font to a lower size
+in the `config.h` file to avoid this. By default, JoyPixels is used at a
+smaller size than the usual text.
## Contact
-- Tyler Hoang <tyler@tylerhoang.xyz>
-- [https://tylerhoang.xyz](https://tylerhoang.xyz)
+- Luke Smith <luke@lukesmith.xyz>
+- [https://lukesmith.xyz](https://lukesmith.xyz)