psi-jack/dotbot
1
0
Fork 0
mirror of synced 2024-12-22 06:01:07 -05:00
Code Issues Releases Wiki Activity

Update README

Browse source 
Add a note about copying the install script and not using a symbolic
link.
This commit is contained in:
Anish Athalye 2014-12-27 15:17:38 -05:00
parent 2eb6353b16
commit 1221ad0f9b
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -68,6 +68,16 @@ the configuration is located in `install.conf.yaml` and Dotbot is located in
`dotbot`. The script automatically makes sure that the correct version of
Dotbot is checked out in the submodule.
This script should be **copied** into your dotfiles repository. Once the
install script has been copied into your dotfiles, there is no need to modify
the script again -- it is merely a shim that checks out the appropriate version
of Dotbot and calls the full Dotbot installer. Note that using a symbolic link
to the sample install script included in the Dotbot repository won't work
correctly -- it can actually lead to several problems. For example, when
cloning your dotfiles onto a new system, the Dotbot submodule won't be
initialized (unless you use the `--recursive` flag), so the symbolic link will
be broken, pointing to a nonexistent file.
Adapting the bootstrap script for different situations (such as using a
different VCS) is fairly straightforward.