mirrors/dotdrop
1
0
Fork 0
mirror of https://github.com/deadc0de6/dotdrop.git synced 2026-02-11 16:04:00 +00:00
Code Activity

update readme

Browse Source
This commit is contained in:
deadc0de6
2019-03-08 08:38:28 +01:00
parent b3ef3cb33b
commit 4b49891b7c
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -646,15 +646,15 @@ For example
# Config # Config
The config file (defaults to *config.yaml*) is a yaml file containing The config file (which defaults to *config.yaml*) is a yaml file containing
the following entries: the following entries:
* **config** entry: contains settings for the deployment * **config** entry (mandatory): contains settings for the deployment
* `backup`: create a backup of the dotfile in case it differs from the * `backup`: create a backup of the dotfile in case it differs from the
one that will be installed by dotdrop (default *true*) one that will be installed by dotdrop (default *true*)
* `create`: create directory hierarchy when installing dotfiles if * `create`: create directory hierarchy when installing dotfiles if
it doesn't exist (default *true*) it doesn't exist (default *true*)
* `dotpath`: path to the directory containing the dotfiles to be managed * `dotpath`: path to the directory containing the dotfiles to be managed (default `dotfiles`)
by dotdrop (absolute path or relative to the config file location) by dotdrop (absolute path or relative to the config file location)
* `banner`: display the banner (default *true*) * `banner`: display the banner (default *true*)
* `longkey`: use long keys for dotfiles when importing (default *false*) * `longkey`: use long keys for dotfiles when importing (default *false*)
@@ -667,7 +667,7 @@ the following entries:
* `import_variables`: list of paths to load variables from * `import_variables`: list of paths to load variables from
(absolute path or relative to the config file location). (absolute path or relative to the config file location).
* **dotfiles** entry: a list of dotfiles * **dotfiles** entry (mandatory): a list of dotfiles
* `dst`: where this dotfile needs to be deployed (can use `variables` and `dynvariables`, make sure to quote). * `dst`: where this dotfile needs to be deployed (can use `variables` and `dynvariables`, make sure to quote).
* `src`: dotfile path within the `dotpath` (can use `variables` and `dynvariables`, make sure to quote). * `src`: dotfile path within the `dotpath` (can use `variables` and `dynvariables`, make sure to quote).
* `link`: if true dotdrop will create a symlink instead of copying (default *false*). * `link`: if true dotdrop will create a symlink instead of copying (default *false*).
@@ -696,7 +696,7 @@ the following entries:
trans_write: <transformation-key> trans_write: <transformation-key>
``` ```
* **profiles** entry: a list of profiles with the different dotfiles that * **profiles** entry (mandatory): a list of profiles with the different dotfiles that
need to be managed need to be managed
* `dotfiles`: the dotfiles associated to this profile * `dotfiles`: the dotfiles associated to this profile
* `include`: include all dotfiles from another profile (optional) * `include`: include all dotfiles from another profile (optional)