readme changes
This commit is contained in:
parent
fa3c401390
commit
d39ded34f1
44
README.md
44
README.md
@ -1,6 +1,7 @@
|
||||
# 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)
|
||||
|
||||
@ -10,9 +11,12 @@ The [suckless terminal (st)](https://st.suckless.org/) with some additional feat
|
||||
|
||||
## Bindings for
|
||||
|
||||
+ scroll with `alt-↑/↓` or `alt-pageup/down` or `shift` while scrolling the mouse ([scroll](https://github.com/lukesmithxyz/scroll) must be installed)
|
||||
+ 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
|
||||
+ 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
|
||||
+ **copy text** with `alt-c`, **paste** is `alt-v` or `shift-insert`
|
||||
|
||||
## Pretty stuff
|
||||
@ -20,7 +24,8 @@ 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
|
||||
|
||||
@ -39,17 +44,28 @@ cd st
|
||||
sudo make install
|
||||
```
|
||||
|
||||
Users of Arch-based distros can also install it from the AUR as [st-luke-git](https://aur.archlinux.org/packages/st-luke-git/).
|
||||
Note that [scroll](https://github.com/lukesmithxyz/scroll) is automatically
|
||||
pulled and installed when you make this build of st.
|
||||
|
||||
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.
|
||||
Users of Arch-based distros can also install it from the AUR as
|
||||
[st-luke-git](https://aur.archlinux.org/packages/st-luke-git/).
|
||||
|
||||
On OpenBSD, be sure to edit `config.mk` first and remove `-lrt` from the `$LIBS` before compiling.
|
||||
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.
|
||||
|
||||
Be sure to have a composite manager (`xcompmgr`, `picom`, etc.) running if you want transparency.
|
||||
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.
|
||||
|
||||
## 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:
|
||||
|
||||
@ -74,9 +90,13 @@ 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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user