From 86fa7439882bebb2c82da09782eca892a85d8e34 Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Mon, 25 May 2020 17:31:28 +0200 Subject: [PATCH] [repo] Update README with submodule information Added information on automatically pulling git submodules on initial clone. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b97d6ec..3ed7396 100644 --- a/README.md +++ b/README.md @@ -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).