diff options
author | Anish Athalye <me@anishathalye.com> | 2014-12-27 15:17:38 -0500 |
---|---|---|
committer | Anish Athalye <me@anishathalye.com> | 2014-12-27 15:17:38 -0500 |
commit | 1221ad0f9bca09ce9d79f9ae86cad21d22ef9ff2 (patch) | |
tree | 370ae3cbd4807e62f6300957a043ee8a56ba2304 /README.md | |
parent | 2eb6353b16fae2e41efe4761979c70f3c8bc9d1b (diff) |
Update README
Add a note about copying the install script and not using a symbolic
link.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -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. |