diff options
author | Jesse Duffield <jessedduffield@gmail.com> | 2018-09-01 14:35:46 +1000 |
---|---|---|
committer | Jesse Duffield <jessedduffield@gmail.com> | 2018-09-01 14:35:46 +1000 |
commit | 3cafa2bb12578c89137b43c159b900878c4d193a (patch) | |
tree | 3233de172fc87e59873d3cc3c47408a6173acaf0 /docs | |
parent | d31520261f0ffc4cb93e29476e39ace45e813fc8 (diff) |
update config to reflect platform specific defaults
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Config.md | 34 |
1 files changed, 32 insertions, 2 deletions
diff --git a/docs/Config.md b/docs/Config.md index 02b377b95..d428603bc 100644 --- a/docs/Config.md +++ b/docs/Config.md @@ -14,14 +14,44 @@ - white optionsTextColor: - blue - os: - openCommand: 'open {{filename}}' update: method: prompt # can be: prompt | background | never days: 14 # how often an update is checked for reporting: 'undetermined' # one of: 'on' | 'off' | 'undetermined' ``` +## Platform Defaults: + +### Windows: + +``` + os: + openCommand: 'cmd /c "start "" {{filename}}"' +``` + +### Linux: + +``` + os: + openCommand: 'bash -c \"xdg-open {{filename}} &>/dev/null &\"' +``` + +### OSX: + +``` + os: + openCommand: 'open {{filename}}' +``` + +### Recommended Config Values: + +for users of VSCode + +``` + os: + openCommand: 'code -r {{filename}}' +``` + ## Color Attributes: For color attributes you can choose an array of attributes (with max one color attribute) |