Marty
/
dotfiles
1
0
Fork 0
Code Issues 3 Pull Requests Projects Releases Wiki Activity

[repo] Update README with submodule information 

Added information on automatically pulling git submodules on initial
clone.
This commit is contained in:
Marty Oehme 2020-05-25 17:31:28 +02:00
parent 5aad473ab5
commit 86fa743988
No known key found for this signature in database
GPG Key ID: 0CCB0526EFB9611A
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -19,6 +19,8 @@
The dotfiles use `GNU stow` to link themselves in the home directory. You can clone this repository anywhere (though I have mine in `~/.dotfiles` as it seemed most logical for me).
I would recommend doing a `git clone --recursive` for this repository, since it contains git [submodules](https://nering.dev/2016/git-submodules-vs-subtrees/), which will then automatically get pulled in as well. Of course, you can do it non-recursively and then just pull those modules selectively which you actually want.
Once in the repository directory, when you then run `./install.sh` it will install many of the packages I use (though they are probably slightly out-of-date) and link the dotfiles into the home directory.
Since it is based on `stow`, it will not overwrite anything already in the home directory (though you can force it to if you really want, using `stow --override='.*'` -- I do not recommend this).