Add create
directive to readme.
This commit is contained in:
parent
773aa5b37a
commit
85c62c8d88
30
README.md
30
README.md
|
@ -105,6 +105,11 @@ The conventional name for the configuration file is `install.conf.yaml`.
|
||||||
~/.vim: vim
|
~/.vim: vim
|
||||||
~/.vimrc: vimrc
|
~/.vimrc: vimrc
|
||||||
|
|
||||||
|
- create:
|
||||||
|
- ~/projects
|
||||||
|
- ~/downloads
|
||||||
|
- ~/.vim/undo-history
|
||||||
|
|
||||||
- shell:
|
- shell:
|
||||||
- [git submodule update --init --recursive, Installing submodules]
|
- [git submodule update --init --recursive, Installing submodules]
|
||||||
```
|
```
|
||||||
|
@ -119,9 +124,9 @@ Configuration
|
||||||
|
|
||||||
Dotbot uses YAML or JSON-formatted configuration files to let you specify how
|
Dotbot uses YAML or JSON-formatted configuration files to let you specify how
|
||||||
to set up your dotfiles. Currently, Dotbot knows how to [link](#link) files and
|
to set up your dotfiles. Currently, Dotbot knows how to [link](#link) files and
|
||||||
folders, execute [shell](#shell) commands, and [clean](#clean) directories of
|
folders, [create](#create) folders, execute [shell](#shell) commands, and
|
||||||
broken symbolic links. Dotbot also supports user [plugins](#plugins) for custom
|
[clean](#clean) directories of broken symbolic links. Dotbot also supports user
|
||||||
commands.
|
[plugins](#plugins) for custom commands.
|
||||||
|
|
||||||
**Ideally, bootstrap configurations should be idempotent. That is, the
|
**Ideally, bootstrap configurations should be idempotent. That is, the
|
||||||
installer should be able to be run multiple times without causing any
|
installer should be able to be run multiple times without causing any
|
||||||
|
@ -219,6 +224,25 @@ the following config files equivalent:
|
||||||
relink: true
|
relink: true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Create
|
||||||
|
|
||||||
|
Create commands specify empty directories to be created. This can be useful
|
||||||
|
for scaffolding out folders or parent folder structure required for various
|
||||||
|
apps, plugins, shell commands, etc.
|
||||||
|
|
||||||
|
#### Format
|
||||||
|
|
||||||
|
Create commands are specified as an array of directories to be created.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- create:
|
||||||
|
- ~/projects
|
||||||
|
- ~/downloads
|
||||||
|
- ~/.vim/undo-history
|
||||||
|
```
|
||||||
|
|
||||||
### Shell
|
### Shell
|
||||||
|
|
||||||
Shell commands specify shell commands to be run. Shell commands are run in the
|
Shell commands specify shell commands to be run. Shell commands are run in the
|
||||||
|
|
Loading…
Reference in a new issue