Add basic README.md

1 files changed, 14 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..51d2d8e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Files with dots
+
+## Prerequisites
+
+* [chezmoi](https://www.chezmoi.io/) for managing the dotfiles
+* Functional pager for chezmoi on macOS, consider either:
+  * Up-to-date version of [`less`](https://formulae.brew.sh/formula/less)
+  * Alternative pager like [`delta`](https://formulae.brew.sh/formula/git-delta)
+
+## Setup
+
+* Run `chezmoi init git@dotfiles.xyz:dotfiles.git` to initialise chezmoi dotfiles.
+* Run `chezmoi apply` to apply dotfiles.
+* Run `chezmoi update` to update dotfiles.