punktdateien/README.md

69 lines
1.8 KiB
Markdown
Raw Normal View History

# jstm's dotfiles
2023-12-09 15:27:27 +01:00
## Read this first!
2023-12-09 15:28:03 +01:00
Running `install.sh` or `uninstall.sh` will delete and change some things in your home directory!
2023-12-09 15:27:27 +01:00
### 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
2023-12-09 19:02:21 +01:00
- ~/.config/kvantum
2023-12-09 15:27:27 +01:00
- ~/.icons
- ~/.local/share/icons
- ~/.fonts
- ~/.config/fontconfig
### Affected files
- ~/.bashrc
- ~/.config/starship.toml
- ~/.config/jstmbash.env
2023-12-13 19:01:39 +01:00
- ~/.config/konsolerc
2023-12-09 15:27:27 +01:00
- ~/.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. \
2023-12-09 15:28:03 +01:00
If you wish to make your own dotfiles repo, you can of course modify files and then make your own repository.
2023-12-09 15:27:27 +01:00
## 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
2023-12-09 15:45:17 +01:00
This will reset all programs to their original state and remove `~/.dotfiles` completely.
```bash
cd "$HOME/.dotfiles"
2023-12-09 15:47:41 +01:00
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.