From a2224475dbab9ab0cbe23f3b776e52ecb79756b7 Mon Sep 17 00:00:00 2001
From: Keegan Conlee <dacid44@gmail.com>
Date: Wed, 17 Jul 2024 11:13:08 -0500
Subject: [PATCH] docs: move whiskers documentation to the main README.md

---
 README.md                                     | 20 ++++++++++++++++++-
 ...-whiskers.json => carburetor-whiskers.json |  0
 whiskers/whiskers.md                          | 16 ---------------
 3 files changed, 19 insertions(+), 17 deletions(-)
 rename whiskers/carburetor-whiskers.json => carburetor-whiskers.json (100%)
 delete mode 100644 whiskers/whiskers.md

diff --git a/README.md b/README.md
index a9cf524..36a3388 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,8 @@ An IBM Carbon inspired colorscheme.
 2. [Usage](#usage)
     1. [Nix](#nix)
     2. [Patch Tool](#patch-tool)
-    3. [Config Examples](#config-examples)
+    3. [Catppuccin whiskers](#catppuccin-whiskers)
+    4. [Config Examples](#config-examples)
         1. [Nvim](#nvim)
         2. [Wezterm](#wezterm)
         3. [Discord](#discord)
@@ -75,6 +76,23 @@ Options:
   TRANSPARENCY: true | false
 ```
 
+### Catppuccin `whiskers`
+
+Catppuccin has a tool called [whiskers](https://github.com/catppuccin/whiskers) which is used to create color schemes from template files. The [`carburetor-whiskers.json`](carburetor-whiskers.json) file can be used to generate a Carburetor color scheme for any template file that works with `whiskers`.
+
+#### Example: Zed
+The same process should apply for whichever program you would like to create a Carburetor color scheme for.
+
+1. [Install whiskers](https://github.com/catppuccin/whiskers?tab=readme-ov-file#installation)
+2. Download the [template file for Zed](https://github.com/catppuccin/zed/blob/main/zed.tera)
+3. (Optional) customize the template file as you like (e.g. changing the names of color schemes, etc.). Documentation for the template syntax `whiskers` uses is available [here](https://github.com/catppuccin/whiskers?tab=readme-ov-file#template).
+4. Run (customizing the input filename and output format for your template):
+```
+whiskers zed.tera -o json --color-overrides carburetor-whiskers.json
+```
+5. `whiskers` should generate one or more color scheme files, dependent on the template. For Zed, it generates a `themes` directory with color scheme files for each accent color.
+6. Install your color scheme!
+
 ---
 
 ### Config Examples
diff --git a/whiskers/carburetor-whiskers.json b/carburetor-whiskers.json
similarity index 100%
rename from whiskers/carburetor-whiskers.json
rename to carburetor-whiskers.json
diff --git a/whiskers/whiskers.md b/whiskers/whiskers.md
deleted file mode 100644
index 496eff9..0000000
--- a/whiskers/whiskers.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# Building a color scheme with catppuccin-whiskers
-
-Catppuccin has a tool called [whiskers](https://github.com/catppuccin/whiskers) which is used to create color schemes from template files. The [`carburetor-whiskers.json`](carburetor-whiskers.json) file in this folder can be used to generate a Carburetor color scheme for any template file that works with `whiskers`.
-
-## Example: Zed
-The same process should apply for whichever program you would like to create a Carburetor color scheme for.
-
-1. [Install whiskers](https://github.com/catppuccin/whiskers?tab=readme-ov-file#installation)
-2. Download the [template file for Zed](https://github.com/catppuccin/zed/blob/main/zed.tera)
-3. (Optional) customize the template file as you like (e.g. changing the names of color schemes, etc.). Documentation for the template syntax `whiskers` uses is available [here](https://github.com/catppuccin/whiskers?tab=readme-ov-file#template).
-4. Run (customizing the input filename and output format for your template):
-```
-whiskers zed.tera -o json --color-overrides carburetor-whiskers.json
-```
-5. `whiskers` should generate one or more color scheme files, dependent on the template. For Zed, it generates a `themes` directory with color scheme files for each accent color.
-6. Install your color scheme!