punktdateien/README.md

68 lines
1.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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
- ~/.config/kvantum
- ~/.icons
- ~/.local/share/icons
- ~/.fonts
- ~/.config/fontconfig
### Affected files
- ~/.bashrc
- ~/.config/starship.toml
- ~/.config/jstmbash.env
- ~/.config/konsolerc
- ~/.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.
## Managing
### Installing
This will remove all related files and install some software.
```bash
git clone https://git.staropensource.de/JeremyStarTM/punktdateien.git "$HOME/.dotfiles"
cd "$HOME/.dotfiles"
./install.sh
bin/install-software
```
### Updating
This will remove all related files, pull and then link everything again automatically.
```bash
dotfiles-updater
```
### Uninstalling
This will reset all programs to their original state and remove `~/.dotfiles` completely.
```bash
cd "$HOME/.dotfiles"
env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh
cd "$HOME"
rm -rf "$HOME/.dotfiles"
```
### Repairing
This will *should* repair any issues you could have with this repository.
```bash
cd "$HOME/.dotfiles"
env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh
./install.sh
"$HOME/.local/bin/dotfiles-updater" --force
"$HOME/.local/bin/dotfiles-install-software"
``
If you are still facing issues, contact me.