45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
# jstm's dotfiles
|
||
## Read this first!
|
||
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.
|
||
|
||
## 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" # Note: Append --gui to this command if you are using the GUI stuff too
|
||
```
|
||
|
||
If you are still facing issues, open an issue.
|
||
|
||
# Licensing
|
||
All of my own scripts are licensed under the GNU AGPL v3. \
|
||
Work of others may be licensed under different terms.
|