aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHimbeerserverDE <himbeerserverde@gmail.com>2023-09-09 23:16:37 +0200
committerHimbeerserverDE <himbeerserverde@gmail.com>2023-09-09 23:16:37 +0200
commitf62f6d5fe43409f097b902104cc1cca643acbdce (patch)
tree5bae1b75b8e91b5840d476b6fb487c35c8a05ab6 /README.md
parentc7e34bd57b8b0903c86e0529f4af185e7c3bf8ce (diff)
fmt
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index a98740b..f43d463 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# bspwm-setup
+
## Software
+
The software the scripts install depends on your distro.
I don't maintain a separate list in the README anymore,
but you can look at the scripts yourself (you should already be doing this).
@@ -10,6 +12,7 @@ to `/etc/X11/xorg.conf.d/00-keyboard.conf` automatically.
You should set your desired primary video output in `~/.primary_monitor`.
## install.sh
+
The `install.sh` script installs the entire setup.
To do this, it first calls `shell_only.sh` and then does some additional stuff.
@@ -21,6 +24,7 @@ into the repo. On top of this the configs can easily be updated
by running `git pull`.
## shell_only.sh
+
The `shell_only.sh` script installs zsh with a custom theme
and some utilities.
@@ -31,19 +35,26 @@ on headless servers, or if you don't want to use the rest of the setup.
A full install is recommended.
## Starting a X session
+
By default this setup launches X when zsh is started on tty1.
You can however use a display manager if you want.
## Keybinds / Controls
+
### sxhkd
+
The sxhkd keybinds are well documented in `sxhkdrc`.
### Vim
+
#### Normal mode
+
- `Enter`: Insert new line above current line
### tmux
+
#### Prefix: ctrl + s
+
- `x`: Display panes
- `q`: Kill pane
- `shift + h`: Horizontal split