JeremyStarTM/punktdateien
1
0
Fork 0
Code Issues Pull requests Releases Activity

Update README.md

Browse source
This commit is contained in:
JeremyStar™ 2024-06-02 17:24:49 +02:00
parent d3360f507c
commit e1cb468d88
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
1 changed files with 16 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
README.md
View file

@ -1,76 +1,44 @@
# jstm's dotfiles # jstm's dotfiles
## Read this first! ## Read this first!
Running `install.sh` or `uninstall.sh` will delete and change some things in your home directory! Running `install.sh` or `uninstall.sh` will delete and change some things in your home directory! Make sure to first read and understand both scripts before continuing.
### Affected directories
- ~/.jstmbash
- ~/.config/hypr
- ~/.config/waybar
- ~/.config/fnott
- ~/.config/eww
- ~/.config/copyq
- ~/.config/neofetch
- ~/.config/btop
- ~/.config/gimp/splashes
- ~/.config/gitui
- ~/.local/share/mc
- ~/.config/mc
- ~/.config/mpv
- ~/.config/nwg-look
- ~/.config/qt5ct
- ~/.config/qt6ct
- ~/.config/kvantum
- ~/.icons
- ~/.local/share/icons
- ~/.fonts
- ~/.config/fontconfig
- ~/.local/share/color-schemes
- ~/.local/share/aurorae
- ~/.local/share/wallpapers
### 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 ## Managing
### Installing ### Installing
This will remove all related files and install some software. This will remove all related files and install some software.
```bash ```bash
git clone https://git.staropensource.de/JeremyStarTM/punktdateien.git "$HOME/.dotfiles" git clone https://git.staropensource.de/JeremyStarTM/punktdateien.git "${HOME}/.dotfiles"
cd "$HOME/.dotfiles" cd "${HOME}/.dotfiles"
./install.sh ./install.sh
bin/install-software bin/install-software
``` ```
### Updating ### Updating
This will remove all related files, pull and then link everything again – automatically. This will remove all related files, pull and then link everything again – automatically. \
```bash ```bash
dotfiles-updater dotfiles-updater
``` ```
### Uninstalling ### Uninstalling
This will reset all programs to their original state and remove `~/.dotfiles` completely. This will reset all programs to their original state and remove `~/.dotfiles` completely.
```bash ```bash
cd "$HOME/.dotfiles" cd "${HOME}/.dotfiles"
env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh
cd "$HOME" cd "${HOME}"
rm -rf "$HOME/.dotfiles" rm -rf "${HOME}/.dotfiles"
``` ```
### Repairing ### Repairing
This will *should* repair any issues you could have with this repository. This will *should* repair any issues you could have with this repository.
```bash ```bash
cd "$HOME/.dotfiles" cd "${HOME}/.dotfiles"
env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh
./install.sh ./install.sh
"$HOME/.local/bin/dotfiles-updater" --force "${HOME}/.local/bin/dotfiles-updater" --force
"$HOME/.local/bin/dotfiles-install-software" "${HOME}/.local/bin/dotfiles-install-software" # Note: Append --gui to this command if you are using the GUI stuff too
``` ```
If you are still facing issues, contact me.
If you are still facing issues, open an issue.
# Licensing # Licensing
All of my own scripts are licensed under the GNU AGPL v3. \ All of my own scripts are licensed under the GNU AGPL v3. \