summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 63bb8f1..4d0e959 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,15 @@
A Git repository to track my personal GNU/Linux dotfiles.
+## Usage
+
+Install these dotfiles to the current user on a new system like this:
+
+```bash
+ cd ~ # switch to home folder
+ git clone --bare https://github.com/xengineering/dotfiles.git # clone the bare repository
+ git --git-dir=$HOME/dotfiles.git/ --work-tree=$HOME checkout # checkout dotfiles to your home
+ # (append '-f' to overwrite local ones)
+ logout # you have to log in again to make the changes take effect
+```
+