summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md50
1 files changed, 27 insertions, 23 deletions
diff --git a/README.md b/README.md
index 5afdbb1..ae4078e 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,43 @@
# Luke's build of st - the simple (suckless) terminal
-The [suckless terminal (st)](https://st.suckless.org/) with some additional features:
+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)
+
++ **follow urls** by pressing `alt-l`
++ **copy urls** in the same way with `alt-y`
++ **copy the output of commands** with `alt-o`
+
+## 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
++ **copy text** with `alt-c`, **paste** is `alt-v` or `shift-insert`
+
+## Pretty stuff
+ Compatibility with `Xresources` and `pywal` for dynamic colors. The `Xdefaults` file shows a usage example.
+ Default [gruvbox](https://github.com/morhetz/gruvbox) colors otherwise.
-+ Transparency/alpha, which is also adjustable from `~/.Xresources`.
++ Transparency/alpha, which is also adjustable from your `Xresources`.
+ Default font is system "mono" at 16pt, meaning the font will match your system font.
-+ Very useful keybinds including:
- + Copy is alt-c, paste is alt-v or alt-p pastes from primary selection
- + Alt-l feeds all urls on screen to dmenu, so they user can choose and
- follow one (requires dmenu installed).
- + Zoom in/out or increase font size with Alt+Shift+k/j or u/d for larger intervals.
- + Hold alt and press either ↑/↓ or the vim keys k/j to move up/down in the terminal.
- + Shift+Mouse wheel do the same.
- + Alt-u and Alt-d scroll back/forward in history a page at a time.
- + Alt-PageUp and Alt-PageDown will do the same.
-+ Vertcenter
-+ Scrollback
-+ updated to latest version 0.8.1
-The following additional bindings were added before I forked this:
+## Other st patches
-+ Scroll through history -- Shift+PageUp/PageDown or Shift+Mouse wheel
-+ Increase/decrease font size -- Shift+Alt+PageUp/PageDown
-+ Return to default font size -- Alt+Home
-+ Paste -- Shift+Insert
++ Vertcenter
++ Scrollback
++ updated to latest version 0.8.2
## Installation for newbs
```
-make
+git clone https://github.com/LukeSmithxyz/st
+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/).
+
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.
@@ -47,13 +52,12 @@ For example, you can define your desired fonts, transparency or colors:
```
*.font: Liberation Mono:pixelsize=12:antialias=true:autohint=true;
-*.alpha: 150
+*.alpha: 0.9
*.color0: #111
...
```
-The `alpha` value (for transparency) goes from `0` (transparent) to `255`
-(opaque).
+The `alpha` value (for transparency) goes from `0` (transparent) to `1` (opaque).
### Colors