punktdateien/README.md

46 lines
1.4 KiB
Markdown
Raw Normal View History

# jstm's dotfiles
2023-12-09 15:27:27 +01:00
## Read this first!
2024-06-02 17:24:49 +02:00
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.
2023-12-09 15:27:27 +01:00
## Managing
### Installing
This will remove all related files and install some software.
2024-06-02 17:24:49 +02:00
```bash
2024-06-02 17:24:49 +02:00
git clone https://git.staropensource.de/JeremyStarTM/punktdateien.git "${HOME}/.dotfiles"
cd "${HOME}/.dotfiles"
./install.sh
bin/install-software
```
### Updating
2024-06-02 17:24:49 +02:00
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.
2024-06-02 17:24:49 +02:00
```bash
2024-06-02 17:24:49 +02:00
cd "${HOME}/.dotfiles"
2023-12-09 15:47:41 +01:00
env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh
2024-06-02 17:24:49 +02:00
cd "${HOME}"
rm -rf "${HOME}/.dotfiles"
```
### Repairing
This will *should* repair any issues you could have with this repository.
2024-06-02 17:24:49 +02:00
```bash
2024-06-02 17:24:49 +02:00
cd "${HOME}/.dotfiles"
env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh
./install.sh
2024-06-02 17:24:49 +02:00
"${HOME}/.local/bin/dotfiles-updater" --force
"${HOME}/.local/bin/dotfiles-install-software" # Note: Append --gui to this command if you are using the GUI stuff too
2024-02-11 04:24:42 +01:00
```
2024-06-02 17:24:49 +02:00
If you are still facing issues, open an issue.
2024-06-02 17:22:07 +02:00
# Licensing
All of my own scripts are licensed under the GNU AGPL v3. \
Work of others may be licensed under different terms.