aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHimbeerserverDE <himbeerserverde@gmail.com>2023-02-16 21:03:00 +0100
committerHimbeerserverDE <himbeerserverde@gmail.com>2023-02-16 21:03:00 +0100
commit5ef1c7509106c1246e3e5089ce1d49972161c86e (patch)
treeb2055484ebc2b7f91bedb03950ec09266804051b
parent9aee9fa6448ecfd31a2f9914240d0b35e94b48ed (diff)
fix readme details
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 128407c..21cc1bb 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# bspwm-setup
## Software
The software the scripts install depends on your distro.
-I don't maintain a seperate list in the README anymore,
+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).
bspwm will attempt to load the keyboard layout in `~/.xkeymap`.
@@ -11,14 +11,14 @@ the lower case two character code (e.g. `us` or `de`).
## 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.
+
It then symlinks the configuration files for those packages
to the files in this repository. This has two advantages.
First, I can easily make changes and don't have to copy configs
into the repo. On top of this the configs can easily be updated
by running `git pull`.
-After that `shell_only.sh` is started.
-
## shell_only.sh
The `shell_only.sh` script installs zsh with a custom theme
and some utilities.
@@ -27,6 +27,8 @@ Just like `install.sh` this script symlinks the configuration files.
You can run this instead of install.sh to install the shell setup
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.