From a727257106e820bf22f29f40c464f1c9a66eeee0 Mon Sep 17 00:00:00 2001 From: Anish Athalye Date: Thu, 20 Mar 2014 22:33:05 -0400 Subject: [PATCH] Add README --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bf464aa --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +Dotfiles Template +================= + +This is a template repository for bootstraping your dotfiles with [Dotbot][1]. + +To get started, you can [fork][2] this repository (and probably delete this +README and rename your version to something like just `dotfiles`). + +In general, I suggest using symbolic links for everything, and using git +submodules whenever possible. + +To keep submodules at their proper versions, you could include something like +`git submodule update --init --recursive` in your `install.conf.json`. + +To upgrade your submodules to their latest versions, you could periodically run +something like the following. + +```bash +git submodule foreach 'git checkout master && git pull && cd "${toplevel}" && git add ":/${path}"' +``` + +Inspiration +----------- + +If you're looking for inspiration for how to structure your dotfiles or what +kinds of things you can include, you could take a look at some repos using +Dotbot. + +* [anishathalye's dotfiles][3] + +If you're using Dotbot and you'd like to include a link to your dotfiles as an +inspiration to others, please submit a pull request. + +[1]: https://github.com/anishathalye/dotbot +[2]: https://github.com/anishathalye/dotfiles_template/fork +[3]: https://github.com/anishathalye/dotfiles