From 413852cb5a688009ad36608ad17b7b7cacb565d9 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Sat, 9 Dec 2023 15:27:27 +0100 Subject: [PATCH] Update README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index 0a6351dd..044382ca 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,39 @@ # jstm's dotfiles +## Read this first! +Running `install.sh` or `uninstall.sh` will delete and change some things in your home directory! \ +### Affected directories +- ~/.jstmbash +- ~/.config/hypr +- ~/.config/waybar +- ~/.config/fnott +- ~/.config/eww +- ~/.config/copyq +- ~/.config/neofetch +- ~/.config/btop +- ~/.local/share/mc +- ~/.config/mc +- ~/.config/mpv +- ~/.config/nwg-look +- ~/.config/qt5ct +- ~/.config/qt6ct +- ~/.icons +- ~/.local/share/icons +- ~/.fonts +- ~/.config/fontconfig +### Affected files +- ~/.bashrc +- ~/.config/starship.toml +- ~/.config/jstmbash.env +- ~/.config/konsolrc +- ~/.config/dolphinrc +- ~/.local/bin/jobrunner +- ~/.local/bin/jobrunner-runjob + +## Recommendation +Please, do not modify any files. It will only cause issues during the update process. \ +If you wish to make your own dotfiles repo, you can of course modify files and then make \ +your own repository. + ## Installing ```bash git clone https://git.staropensource.de/JeremyStarTM/punktdateien.git "$HOME/.dotfiles" @@ -6,6 +41,7 @@ cd "$HOME/.dotfiles" ./install.sh ``` ## Updating +This will remove all related files, pull and then link everything again. \ ```bash cd "$HOME/.dotfiles" ./uninstall.sh @@ -13,6 +49,7 @@ git pull ./install.sh ``` ## Uninstalling +This will reset all programs to their original state and remove ~/.dotfiles completely. \ ```bash cd "$HOME/.dotfiles" env REMOVE_REPOSITORIES=true ./uninstall.sh