summaryrefslogtreecommitdiff
path: root/README.org
blob: f52a687159e3f0afc7a6af8e8629638088375e3c (plain)
1
2
3
4
5
6
7
8
9
10
11
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.