jam/dotfiles
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor improvements on readme

Browse Source
This commit is contained in:
James Dixon 2022-05-09 18:52:55 -04:00
parent 694c340106
commit 0e5fc9e4a9
1 changed files with 42 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -3,41 +3,69 @@
I am using [GNU Stow](https://www.gnu.org/software/stow/) to symlink I am using [GNU Stow](https://www.gnu.org/software/stow/) to symlink
my dotfiles to their correct locations in my `$HOME` directory. my dotfiles to their correct locations in my `$HOME` directory.
## Instructions ## Installing `stow`
### Installing stow ### Ubuntu/Debian
```bash ```bash
apt install stow # debian based distros apt install stow
dnf install stow # fedora based distros
pacman -S stow # arch based distros
brew install stow # macos
``` ```
### Cloning this repo ### Fedora/RHEL
```sh ```bash
dnf install stow
```
### Arch
```bash
pacman -S stow
```
### MacOS
```bash
brew install stow
```
## Cloning this repo
```bash
git clone https://github.com/lemonase/dotfiles.git git clone https://github.com/lemonase/dotfiles.git
cd dotfiles/files cd dotfiles/files
``` ```
### Installing ### Installing symlinks
```sh ```bash
stow --target="$HOME" * stow --target="$HOME" *
``` ```
### Uninstalling ### Uninstalling symlinks
```sh ```bash
stow --delete * stow --delete *
``` ```
### Repair Links ### Repairing symlinks
```sh ```bash
stow --restow * stow --restow *
``` ```
If there are no errors, everything in that directory should be symlinked. If there are no errors, everything in that directory should be symlinked.
Check by doing a quick `ls -al ~/` Check by doing a quick `ls -al ~/`
## Troubleshooting
### Error: File conflicts
```
WARNING! stowing git would cause conflicts:
* existing target is neither a link nor a directory: .gitconfig
```
### Solution
Delete or move file in question