summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLuke Smith <luke@lukesmith.xyz>2018-07-07 03:28:01 -0400
committerLuke Smith <luke@lukesmith.xyz>2018-07-07 03:28:01 -0400
commit7f231a6b5400933aee77daa2396db490067b644c (patch)
tree8dc82eb6fff01ad7d6c498d2e547df70b0b7c443 /README.md
parent195535faccf91b35322fe54e54237152bccad703 (diff)
xresources patch now default
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 17 insertions, 35 deletions
diff --git a/README.md b/README.md
index f726442..ab8fe3b 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,21 @@
# Luke's build of st - the simple (suckless) terminal
-Forked from [https://github.com/shiva/st](https://github.com/shiva/st) for simplicity's sake, which is the [suckless terminal (st)](https://st.suckless.org/) with some patches added:
-+ transparency
-+ copy to clipboard (alt-shift-c)
-+ Optional compatibility with `Xresources` and `pywal` for dynamic colors
-+ Solarized colors (light and dark toggleable)
-+ vertcenter
-+ scrollback with keyboard
-+ scrollback with mouse
-+ updated to latest version 0.8.1
-
-## My own additions
+Forked from [https://github.com/shiva/st](https://github.com/shiva/st) for simplicity's sake, which is the [suckless terminal (st)](https://st.suckless.org/) with some additional features:
++ Adjustable transparency/alpha
++ Compatibility with `Xresources` and `pywal` for dynamic colors
++ Copy to clipboard (alt-shift-c)
+ Default font is system "mono" at 14pt, meaning the font will match your system font.
+ Hold alt and press either ↑/↓ or the vim keys k/j to move up/down in the terminal.
++ Shift+Mouse wheel will as well.
+ Alt-u and Alt-d scroll back/forward in history a page at a time.
-+ Alt-PageUp and Alt-PageDown scroll back/forward in history a page at a time.
-+ Transparency with solarized colors by default.
++ Alt-PageUp and Alt-PageDown will do the same.
+ Zoom in/out with Alt+Shift+k/j or u/d for larger intervals.
++ Vertcenter
++ Optional solarized colors (light and dark toggleable)
++ updated to latest version 0.8.1
-## Terminal-specific mappings
-
-(Additions before me.)
+The following additional bindings were added before I forked this:
+ Scroll through history -- Shift+PageUp/PageDown or Shift+Mouse wheel
+ Increase/decrease font size -- Shift+Alt+PageUp/PageDown
@@ -39,29 +33,17 @@ Obviously, `make` is required to build. `fontconfig` is required for the default
## Custom changes (`config.def.h` or `config.h`)
-### Solarized
-
-By default, the terminal is transparent with a blackish background. There's a patch file `solarized-alpha-toggle.patch` which you can use to remove the transparency and give it a typical deep, dark blue solarized background. Just run:
+Now by default, the terminal is transparent and uses an Xresources patch that
+looks for your Xresources colors for the colors of st. You can disable the
+Xresources patch by reversing it as below:
```
-patch < solarized-alpha-toggle.patch
+patch -R < xresources.patch
```
-Then, run `make` & `sudo make install` again to install the new build. You make reverse the solarized background by running the same command as above, but giving `patch` the `-R` option as well.
-
-### `Xresources` and `pywal`/`wal` compatibility
-
-If you use `wal` to maintain color schemes across your programs, you can use the `xresources.patch`.
+On top of that, you can disable alpha and enable fully solarized colors by
+running the following:
```
-patch < xresources.patch
-make && sudo make install
+patch < solarized-alpha-toggle.patch
```
-
-## Explore `config.h`
-
-+ Change `colorname[]` array values (88 LOC), default colours are solarized.
-+ Numbers of 0 - 15 are usual terminal colors. Change them to your liking.
-+ Change `bg` to your desired terminal background color.
-+ Change `fg` to your desired terminal foreground color.
-+ Change `cursor` to your desired terminal cursor color.