From b3cce867257e4ca98d6ca03cf807213eaec21d7f Mon Sep 17 00:00:00 2001
From: JeremyStarTM <jeremystartm@staropensource.de>
Date: Mon, 3 Jun 2024 20:17:30 +0200
Subject: [PATCH] Comment management code

---
 README.md | 28 +++++++++++++++++++++++++---
 1 file changed, 25 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 298dbbad..c0eafecb 100644
--- a/README.md
+++ b/README.md
@@ -7,9 +7,15 @@ Running `install.sh` or `uninstall.sh` will delete and change some things in you
 These commands will remove some files and install software.
 
 ```bash
+# Clone repository
 git clone https://git.staropensource.de/JeremyStarTM/punktdateien.git "${HOME}/.dotfiles"
 cd "${HOME}/.dotfiles"
+
+# Install and link files
 ./install.sh
+
+# Install software
+# Append --gui to install GUI packages too
 bin/install-software
 ```
 ### Updating
@@ -23,20 +29,36 @@ dotfiles-updater
 This will remove all installed files & directories and remove `~/.dotfiles` completely.
 
 ```bash
+# Unlink files
 cd "${HOME}/.dotfiles"
 env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh
+
+# Remove ~/.dotfiles
 cd "${HOME}"
-rm -rf "${HOME}/.dotfiles"
+rm -rf ".dotfiles"
 ```
 ### Repairing
 This will *should* repair any issues you could have with this repository.
 
 ```bash
-cd "${HOME}/.dotfiles"
+cd "${HOME}/.dotfiles
+
+# Remove legacy links"
+./uninstall.sh --remove-legacy-paths
+./uninstall.sh --remove-unshared-bashrcd
+
+# Unlink files
 env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh
+
+# Link files
 ./install.sh
+
+# Force update
 "${HOME}/.local/bin/dotfiles-updater" --force
-"${HOME}/.local/bin/dotfiles-install-software"  # Note: Append --gui to this command if you are using the GUI stuff too
+
+# Install required software
+# Append --gui to install/update GUI packages too
+"${HOME}/.local/bin/dotfiles-install-software"
 ```
 
 If you are still facing issues, open an issue.