summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <mail2xengineering@protonmail.com>2020-08-01 17:14:46 +0200
committerxengineering <mail2xengineering@protonmail.com>2020-08-01 17:14:46 +0200
commit0eae900e5f6c56a4f8ad02d523ed3dfe16578321 (patch)
tree1d89009e0b4d5f8314bfe527ef00cff9ae27cf86 /README.md
parentc991d59cee708e070295f395fddcfd45392449e2 (diff)
downloaddotfiles-0eae900e5f6c56a4f8ad02d523ed3dfe16578321.tar
dotfiles-0eae900e5f6c56a4f8ad02d523ed3dfe16578321.tar.zst
dotfiles-0eae900e5f6c56a4f8ad02d523ed3dfe16578321.zip
Add Installation Guide in README.md
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
+```
+