chore: modifies example config

- Generally reduces the complexity demonstrated in the example configs.
  The prior complexity appears to have confused some new users.

- Removes the `dotfiles` references in the example configs. This idiom
  likewise appears to have confused some new users.

- Adds some instruction regarding how to download and configure the
  "community" cheatsheets (`cheat/cheatsheets`).
This commit is contained in:
Chris Lane 2020-01-29 14:01:19 -05:00
parent 9f05442bce
commit bbf6af50b1
2 changed files with 20 additions and 18 deletions

View File

@ -43,22 +43,23 @@ cheatpaths:
# #
# Note that the paths and tags listed below are just examples. You may freely # Note that the paths and tags listed below are just examples. You may freely
# change them to suit your needs. # change them to suit your needs.
#
# TODO: regarding community cheatsheets: these must be installed separately.
# You may download them here:
#
# https://github.com/cheat/cheatsheets
#
# Once downloaded, ensure that 'path' below points to the location at which
# you downloaded the community cheatsheets.
- name: community - name: community
path: ~/.dotfiles/cheat/community path: ~/cheat/cheatsheets/community
tags: [ community ] tags: [ community ]
readonly: true readonly: true
# Maybe your company or department maintains a repository of cheatsheets as
# well. It's probably sensible to list those second.
- name: work
path: ~/.dotfiles/cheat/work
tags: [ work ]
readonly: false
# If you have personalized cheatsheets, list them last. They will take # If you have personalized cheatsheets, list them last. They will take
# precedence over the more global cheatsheets. # precedence over the more global cheatsheets.
- name: personal - name: personal
path: ~/.dotfiles/cheat/personal path: ~/cheat/cheatsheets/personal
tags: [ personal ] tags: [ personal ]
readonly: false readonly: false

View File

@ -34,22 +34,23 @@ cheatpaths:
# #
# Note that the paths and tags listed below are just examples. You may freely # Note that the paths and tags listed below are just examples. You may freely
# change them to suit your needs. # change them to suit your needs.
#
# TODO: regarding community cheatsheets: these must be installed separately.
# You may download them here:
#
# https://github.com/cheat/cheatsheets
#
# Once downloaded, ensure that 'path' below points to the location at which
# you downloaded the community cheatsheets.
- name: community - name: community
path: ~/.dotfiles/cheat/community path: ~/cheat/cheatsheets/community
tags: [ community ] tags: [ community ]
readonly: true readonly: true
# Maybe your company or department maintains a repository of cheatsheets as
# well. It's probably sensible to list those second.
- name: work
path: ~/.dotfiles/cheat/work
tags: [ work ]
readonly: false
# If you have personalized cheatsheets, list them last. They will take # If you have personalized cheatsheets, list them last. They will take
# precedence over the more global cheatsheets. # precedence over the more global cheatsheets.
- name: personal - name: personal
path: ~/.dotfiles/cheat/personal path: ~/cheat/cheatsheets/personal
tags: [ personal ] tags: [ personal ]
readonly: false readonly: false