From: Frederik Vanrenterghem <frederik@vanrenterghem.biz>
Date: Wed, 11 Sep 2019 13:00:41 +0000 (+0800)
Subject: Add README.
X-Git-Url: http://git.vanrenterghem.biz/Dotty.git/commitdiff_plain/f8f57b4c7549ea5ec4d6dafebde19ceacf884af2?hp=6d9c789ae8458589a27e5ae1e39bb3dc25cdaa16

Add README.
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b6ad86a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# About
+Dotty is my repository for dotfiles - various configuration files residing in $HOME.
+
+# How to deploy configuration
+Use `stow` in the root folder, followed by the folder whose config needs to be deployed.
+
+# Format
+Each program that has configuration files has its own subfolder in Dotty.
+Within that folder, the $HOME folder structure is assumed. Hence Dotty/program/.config/config.txt will be deployed to $HOME/.config/config.txt once `stow program` is executed.