Skip to content

Commit b43e043

Browse files
committed
Add section on installing dotfiles
Thanks to Tristan Watson <tristan@thinkastructure.com> for the suggestion to add this to the README.
1 parent 61c21ec commit b43e043

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Dotbot makes installing your dotfiles as easy as `git clone $url && cd dotfiles
55

66
- [Rationale](#rationale)
77
- [Getting Started](#getting-started)
8+
- [Installing Your Dotfiles](#installing-your-dotfiles)
89
- [Configuration](#configuration)
910
- [Directives](#directives) ([Link](#link), [Create](#create), [Shell](#shell), [Clean](#clean), [Defaults](#defaults))
1011
- [Plugins](#plugins)
@@ -140,6 +141,24 @@ The configuration file is typically written in YAML, but it can also be written
140141
in JSON (which is a [subset of YAML][json2yaml]). JSON configuration files are
141142
conventionally named `install.conf.json`.
142143

144+
## Installing Your Dotfiles
145+
146+
To install your dotfiles on a new machine or after updates:
147+
148+
```bash
149+
git clone <your-dotfiles-repo-url> ~/.dotfiles
150+
cd ~/.dotfiles
151+
./install
152+
```
153+
154+
To update an existing installation:
155+
156+
```bash
157+
cd ~/.dotfiles
158+
git pull
159+
./install
160+
```
161+
143162
## Configuration
144163

145164
Dotbot uses YAML or JSON-formatted configuration files to let you specify how

0 commit comments

Comments
 (0)