diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/README.org b/README.org new file mode 100644 index 0000000..f52a687 --- /dev/null +++ b/README.org @@ -0,0 +1,12 @@ +#+TILTE: dotdot +#+SUBTITLE: Programmatic dotfile manager + +* Synopsis +=dotdot= was born as a dotfile manager (though it could be used for many purposes). Fundamentally, its job is: +1. to evaluate a recipe describing e.g. how to set up =~/=, +2. check if the recipe can be executed safely, e.g. that there are no files that would be overwritten, that all necessary directories exist, +3. execute the recipe. +* Usage +Currently, =dotdot= is only intended for my personal use, so I haven’t taken time to document it or even rigorously test it. =dotdot= is provided /as is/, and currently you must read the code to understand how it works. + +I intend to write documentation for it someday, but it’s too currently too early for that. |