summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorKΓ©vin Le Gouguec <kevin.legouguec@gmail.com>2018-02-13 15:42:09 +0100
committerKΓ©vin Le Gouguec <kevin.legouguec@gmail.com>2018-02-13 15:42:09 +0100
commite885aeee35699910b4f08ece45c7c97110ffe41c (patch)
treecda2bb390e9f1f2ea24221ff36c4e27675f15282 /README
parent0a0448876da90426c17f3687e14d408bf9d2b4e0 (diff)
downloaddotfiles-e885aeee35699910b4f08ece45c7c97110ffe41c.tar.xz
Add usage notes
And simplify .gitignore. I originally added !/.* to make sure committed dotfiles would still appear in git status, but that's not necessary: > Files already tracked by Git are not affected > ― gitignore(5) The only downside is that to start tracking new dotfiles, git add will need --force.
Diffstat (limited to 'README')
-rw-r--r--README27
1 files changed, 25 insertions, 2 deletions
diff --git a/README b/README
index a7e840d..2e537e5 100644
--- a/README
+++ b/README
@@ -1,4 +1,27 @@
-What's "dotfiles", precious?
-What's "dotfiles" eh?
+A few good dotfiles
+===================
🎜 Clone'em, tweak'em, stick'em in your $HOME 🎝
+
+Usage notes
+-----------
+
+Some Git sorcery to maximize usability and avoid brittle hacks
+(e.g. symlinks, homebrewed synchronization scripts):
+
+``` sh
+# In $HOME, prepare a Git repository:
+$ git init
+
+# Grab history:
+$ git remote add --fetch $cutename $url
+
+# Move to latest commit without actually touching files:
+$ git reset $cutename/master
+
+# Checkout dotfiles that were not already in $HOME:
+$ git checkout -- .gitignore # …
+
+# Tell Git to forget about repository fluff:
+$ git update-index --assumed-unchanged -- README # …
+```