summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnish Athalye <me@anishathalye.com>2014-10-22 14:44:40 -0400
committerAnish Athalye <me@anishathalye.com>2014-10-22 14:44:40 -0400
commitafebc0bb2fe817778f77d0fcfe30e508bf15d441 (patch)
tree98c0e9b3aefdfb7b0cf9955d37c833542adb1059 /README.md
parent13c925be87ddf946773689ec51fd0251f795a9c4 (diff)
Add functionality to create parent directories
This commit introduces an additional option for extended configuration syntax for linking. It adds the "create" parameter which results in automatically creating a parent directory if necessary before linking a file.
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5c79337..b8896dc 100644
--- a/README.md
+++ b/README.md
@@ -104,14 +104,19 @@ a trailing "/" character.
Link commands support an (optional) extended configuration. In this type of
configuration, instead of specifying source locations directly, targets are
mapped to extended configuration dictionaries. These dictionaries map "path" to
-the source path, and specify "force" as true if the file or directory should be
-forcibly linked.
+the source path, specify "create" as true if the parent directory should be
+created if necessary, and specify "force" as true if the file or directory
+should be forcibly linked.
##### Example
```json
{
"link": {
+ "~/.config/terminator": {
+ "path": "config/terminator/",
+ "create": true
+ },
"~/.vimrc": "vimrc",
"~/.vim": "vim/",
"~/.zshrc": {