68 lines
1.7 KiB
Markdown
68 lines
1.7 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
|
|
These commands will remove some files and install software.
|
|
|
|
```bash
|
|
# Clone repository
|
|
git clone https://git.staropensource.de/JeremyStarTM/punktdateien.git "${HOME}/.dotfiles"
|
|
cd "${HOME}/.dotfiles"
|
|
|
|
# Install and link files
|
|
./install.sh
|
|
|
|
# Install software
|
|
# Append --gui to install GUI packages too
|
|
bin/install-software
|
|
```
|
|
### Updating
|
|
These commands will remove some files, pull changes and link everything again. \
|
|
Make sure to execute `dotfiles-install-software [-gui]` after updating.
|
|
|
|
```bash
|
|
dotfiles-updater
|
|
```
|
|
### Uninstalling
|
|
This will remove all installed files & directories and remove `~/.dotfiles` completely.
|
|
|
|
```bash
|
|
# Unlink files
|
|
cd "${HOME}/.dotfiles"
|
|
env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh
|
|
|
|
# Remove ~/.dotfiles
|
|
cd "${HOME}"
|
|
rm -rf ".dotfiles"
|
|
```
|
|
### Repairing
|
|
This will *should* repair any issues you could have with this repository.
|
|
|
|
```bash
|
|
cd "${HOME}/.dotfiles"
|
|
|
|
# Remove legacy links"
|
|
./uninstall.sh --remove-legacy-paths
|
|
./uninstall.sh --remove-unshared-bashrcd
|
|
|
|
# Unlink files
|
|
env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh
|
|
|
|
# Link files
|
|
./install.sh
|
|
|
|
# Force update
|
|
"${HOME}/.local/bin/dotfiles-updater" --force
|
|
|
|
# Install required software
|
|
# Append --gui to install/update GUI packages too
|
|
"${HOME}/.local/bin/dotfiles-install-software"
|
|
```
|
|
|
|
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.
|