psi-jack
/
dotbot
mirror of
1
0
Fork 0
Code Issues Releases Wiki Activity

Add note to README about JSON parsing 

Casey Rodarmor <casey@rodarmor.com> pointed out that Dotbot parses JSON
files as YAML. The YAML format doesn't allow tab characters, which are
normally allowed in JSON. This patch adds a note about this to the
README.
This commit is contained in:
Anish Athalye 2016-01-11 13:33:31 -05:00
parent 5babc8f562
commit 57265f78b4
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -109,12 +109,17 @@ The conventional name for this file is `install.conf.json`.
]
```
## Configuration
Configuration
-------------
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
folders, execute [shell](#shell) commands, and [clean](#clean) directories of
broken symbolic links.
Dotbot uses YAML or JSON formatted configuration files to let you specify how
to set up your dotfiles. The YAML format is recommended because it looks
cleaner. JSON will be parsed as a subset of YAML, so tab characters are not
permitted.
Currently, Dotbot knows how to [link](#link) files and folders, execute
[shell](#shell) commands, and [clean](#clean) directories of broken symbolic
links.
**Ideally, bootstrap configurations should be idempotent. That is, the
installer should be able to be run multiple times without causing any