From f8f57b4c7549ea5ec4d6dafebde19ceacf884af2 Mon Sep 17 00:00:00 2001 From: Frederik Vanrenterghem Date: Wed, 11 Sep 2019 21:00:41 +0800 Subject: [PATCH] Add README. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md 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. -- 2.39.5