Skip to content

Commit

Permalink
docs: move whiskers documentation to the main README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dacid44 committed Jul 17, 2024
1 parent b3b90f8 commit a222447
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 17 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
File renamed without changes.
16 changes: 0 additions & 16 deletions whiskers/whiskers.md

This file was deleted.

0 comments on commit a222447

Please sign in to comment.