aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 18 insertions, 40 deletions
diff --git a/README.md b/README.md
index ab25f86..d34a781 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-# Luke's build of st - the simple (suckless) terminal
+# 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
-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,12 +11,9 @@ features that make it literally the best terminal emulator ever:
## Bindings for
-+ scroll with `alt-↑/↓` or `alt-pageup/down` or `shift` while scrolling the
- mouse (via [scroll](https://github.com/lukesmithxyz/scroll)).
-+ 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
@@ -24,48 +21,34 @@ features that make it literally the best terminal emulator ever:
+ 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
-+ Boxdraw
-+ Ligatures
++ Vertcenter
++ Scrollback
+ font2
-+ updated to latest version 0.8.4
++ updated to latest version 0.8.2
## Installation for newbs
-You should have xlib header files and libharfbuzz build files installed.
-
```
git clone https://github.com/LukeSmithxyz/st
cd st
sudo make install
```
-Note that [scroll](https://github.com/lukesmithxyz/scroll) is automatically
-pulled and installed when you make this build of st.
-
-Users of Arch-based distros can also install it from the AUR as
-[st-luke-git](https://aur.archlinux.org/packages/st-luke-git/).
+Users of Arch-based distros can also install it from the AUR as [st-luke-git](https://aur.archlinux.org/packages/st-luke-git/).
-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:
@@ -76,8 +59,7 @@ For example, you can define your desired fonts, transparency or colors:
...
```
-The `alpha` value (for transparency) goes from `0` (transparent) to `1`
-(opaque). There is an example `Xdefaults` file in this respository.
+The `alpha` value (for transparency) goes from `0` (transparent) to `1` (opaque).
### Colors
@@ -91,13 +73,9 @@ 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