Update README.md

This commit is contained in:
JeremyStar™ 2023-12-09 15:27:27 +01:00
parent 2090475cbc
commit 413852cb5a

View file

@ -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