From bbf6af50b10213765e11ee97a15d592569be3b77 Mon Sep 17 00:00:00 2001
From: Chris Lane <chris@chris-allen-lane.com>
Date: Wed, 29 Jan 2020 14:01:19 -0500
Subject: [PATCH] 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`).
---
 cmd/cheat/str_config.go | 19 ++++++++++---------
 configs/conf.yml        | 19 ++++++++++---------
 2 files changed, 20 insertions(+), 18 deletions(-)

diff --git a/cmd/cheat/str_config.go b/cmd/cheat/str_config.go
index 9bf4123..03582e0 100644
--- a/cmd/cheat/str_config.go
+++ b/cmd/cheat/str_config.go
@@ -43,22 +43,23 @@ cheatpaths:
   #
   # Note that the paths and tags listed below are just examples. You may freely
   # 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
-    path: ~/.dotfiles/cheat/community
+    path: ~/cheat/cheatsheets/community
     tags: [ community ]
     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
   # precedence over the more global cheatsheets.
   - name: personal
-    path: ~/.dotfiles/cheat/personal
+    path: ~/cheat/cheatsheets/personal
     tags: [ personal ]
     readonly: false
 
diff --git a/configs/conf.yml b/configs/conf.yml
index 428ffac..26f2a1e 100644
--- a/configs/conf.yml
+++ b/configs/conf.yml
@@ -34,22 +34,23 @@ cheatpaths:
   #
   # Note that the paths and tags listed below are just examples. You may freely
   # 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
-    path: ~/.dotfiles/cheat/community
+    path: ~/cheat/cheatsheets/community
     tags: [ community ]
     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
   # precedence over the more global cheatsheets.
   - name: personal
-    path: ~/.dotfiles/cheat/personal
+    path: ~/cheat/cheatsheets/personal
     tags: [ personal ]
     readonly: false