Skip to content

Commit

Permalink
docs: mention the Catppuccin Icons icon pack
Browse files Browse the repository at this point in the history
closes #76
  • Loading branch information
sgoudham committed Dec 7, 2023
1 parent 747edf5 commit 76d5217
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 6 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## [Unreleased]

- (Misc): We now have an icon pack! Search the marketplace for **Catppuccin Icons** to install it!

### Added

### Changed
Expand Down
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,24 @@ Settings</kbd> → <kbd>Plugins</kbd> → ⚙️ → <kbd>Install plugin from di

## Usage

- User Interface: <kbd>Settings</kbd> → <kbd>Appearance & Behaviour</kbd> → <kbd>Appearance</kbd> → Pick your
favourite flavour!
- Code Editor: <kbd>Settings</kbd> → <kbd>Editor</kbd> → <kbd>Color Scheme</kbd> → Pick your favourite flavour!
There are 4 lovely flavours for you to choose from: **Latte**, **Frappé**, **Macchiato** and **Mocha**.

### User Interface

1. Head to <kbd>Settings</kbd> → <kbd>Appearance & Behaviour</kbd> → <kbd>Appearance</kbd>
2. Pick your favourite flavour
3. **(Optional)** Restart your IDE

### Code Editor

1. Head to <kbd>Settings</kbd> → <kbd>Editor</kbd> → <kbd>Color Scheme</kbd>
2. Pick your favourite flavour
3. **(Optional)** Restart your IDE

### Icon Pack

We have created an icon pack, **Catppuccin Icons**, to compliment this theme. Follow the instructions on
the [GitHub repository](https://github.com/catppuccin/jetbrains-icons) to install it.

## Contributing

Expand Down
24 changes: 21 additions & 3 deletions src/main/resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,31 @@ perfect for coding, designing, and much more!
<h3>Usage</h3>
<p>There are 4 lovely flavours for you to choose from, <strong>Latte</strong>, <strong>Frappé</strong>, <strong>Macchiato</strong> and <strong>Mocha</strong>.</p>
<p>There are 4 lovely flavours for you to choose from: <strong>Latte</strong>, <strong>Frappé</strong>, <strong>Macchiato</strong> and <strong>Mocha</strong>.</p>
<h4>User Interface</h4>
<ul>
<li>Head to <strong>Settings</strong> → <strong>Appearance & Behaviour</strong> → <strong>Appearance</strong></li>
<li>Pick your favourite flavour</li>
<li><strong>(Optional)</strong> Restart your IDE</li>
</ul>
<h4>Code Editor</h4>
<ul>
<li>User Interface: <strong>Settings</strong> → <strong>Appearance & Behaviour</strong> → <strong>Appearance</strong> → Pick your favourite flavour!</li>
<li>Code Editor: <strong>Settings</strong> → <strong>Editor</strong> → <strong>Color Scheme</strong> → Pick your favourite flavour!</li>
<li>Head to <strong>Settings</strong> → <strong>Editor</strong> → <strong>Color Scheme</strong></li>
<li>Pick your favourite flavour</li>
<li><strong>(Optional)</strong> Restart your IDE</li>
</ul>
<h4>Icon Pack</h4>
<p>
We have created an icon pack, <strong>Catppuccin Icons</strong>, to compliment this theme. Follow the instructions on
the <a href="https://github.com/catppuccin/jetbrains-icons">GitHub repository</a> to install it.
</p>
<h3>Help</h3>
For further help, see also:
Expand Down

0 comments on commit 76d5217

Please sign in to comment.