Mirrors/catppuccin
2
0
Fork 0
mirror of https://github.com/catppuccin/catppuccin synced 2024-11-22 19:43:05 +00:00
Code Issues Projects Releases Packages Wiki Activity
catppuccin/README.md
elkrien 1364f3cc19
add mouse cursors
2022-02-28 21:22:14 +01:00

197 lines
11 KiB
Markdown
Raw Blame History

<h3 align="center">
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/>
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/misc/transparent.png" height="30" width="0px"/>
Catppuccin Theme
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/misc/transparent.png" height="30" width="0px"/>
</h3>
<h6 align="center">
<a href="https://github.com/catppuccin/catppuccin#-palette">Palette</a>
·
<a href="https://github.com/catppuccin/catppuccin#-ports-and-more">Ports</a>
·
<a href="https://github.com/catppuccin/catppuccin#-design-philosophy">Design Philosophy</a>
</h6>
<p align="center">
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/morning.png" width="185" />
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/night.png" width="185" />
</p>
<p align="center">
<a href="https://github.com/catppuccin/catppuccin/stargazers">
<img alt="Stargazers" src="https://img.shields.io/github/stars/catppuccin/catppuccin?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41"></a>
<a href="https://github.com/catppuccin/catppuccin/releases/latest">
<img alt="Releases" src="https://img.shields.io/github/release/catppuccin/catppuccin.svg?style=for-the-badge&logo=github&color=F2CDCD&logoColor=D9E0EE&labelColor=302D41"/></a>
<a href="https://github.com/catppuccin/catppuccin/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/catppuccin/catppuccin?style=for-the-badge&logo=gitbook&color=B5E8E0&logoColor=D9E0EE&labelColor=302D41"></a>
<a href="https://discord.gg/r6Mdz5dpFc">
<img alt="Discord" src="https://img.shields.io/discord/907385605422448742?style=for-the-badge&logo=discord&color=DDB6F2&logoColor=D9E0EE&labelColor=302D41"></a>
</p>
&nbsp;
<p align="center">
Catppuccin is a community-driven pastel theme that aims to be the middle ground between low and high contrast themes. It consists of a soothing warm palette with 22 eye-candy colors perfect for coding, designing, and much more! In addition, this repository tracks the development of the actual color palette, organization-wide assets, resources and code samples for maintainers/developers.
</p>
&nbsp;
### 🧠 Design Philosophy
- **Colorful is better than colorless**: the colorfulness of something contributes to the distinction amongst the parts of that _something_, making it marginally easier to understand how things are structured.
- **There should be balance**: not too dull, not too bright. Suitability under various light conditions is a most.
- **Harmony is superior to dissonance**: vivacious colors must complement each other.
&nbsp;
### 🎨 Palette
**Catppuccin** constist of two main color palettes. All the details can be found below.<br>
To make the best use them please refer to the [Styleguide](https://github.com/catppuccin/style-guide).
<br><img src="assets/misc/transparent.png" height="10" width="0" />
#### Morning
| | Name | Hex | RGB | HSL | CMYK |
| ----------------------------------------------------------------------- | -------- | --------- | --------------- | --------------- | ------------------ |
| <img src="assets/palette/circles/flamingo.png" height="23" width="23"/> | Flamingo | `#F2CDCD` | `242, 205, 205` | `0, 59%, 88%` | `0%, 15%, 15%, 5%` |
| <img src="assets/palette/circles/mauve.png" height="23" width="23"/> | Mauve | `#DDB6F2` | `221, 182, 242` | `279, 70%, 83%` | `9%, 25%, 0%, 5%` |
| <img src="assets/palette/circles/pink.png" height="23" width="23"/> | Pink | `#F5C2E7` | `245, 194, 231` | `316, 72%, 86%` | `0%, 21%, 6%, 4%` |
| <img src="assets/palette/circles/maroon.png" height="23" width="23"/> | Maroon | `#E8A2AF` | `232, 162, 175` | `349, 60%, 77%` | `0%, 30%, 25%, 9%` |
| <img src="assets/palette/circles/red.png" height="23" width="23"/> | Red | `#F28FAD` | `242, 143, 173` | `342, 79%, 75%` | `0%, 41%, 29%, 5%` |
| <img src="assets/palette/circles/peach.png" height="23" width="23"/> | Peach | `#F8BD96` | `248, 189, 150` | `24, 88%, 78%` | `0%, 24%, 40%, 3%` |
| <img src="assets/palette/circles/yellow.png" height="23" width="23"/> | Yellow | `#FAE3B0` | `250, 227, 176` | `41, 88%, 84%` | `0%, 9%, 30%, 2%` |
| <img src="assets/palette/circles/green.png" height="23" width="23"/> | Green | `#ABE9B3` | `171, 233, 179` | `128, 58%, 79%` | `27%, 0%, 23%, 9%` |
| <img src="assets/palette/circles/teal.png" height="23" width="23"/> | Teal | `#B5E8E0` | `181, 232, 224` | `171, 53%, 81%` | `22%, 0%, 3%, 9%` |
| <img src="assets/palette/circles/blue.png" height="23" width="23"/> | Blue | `#96CDFB` | `150, 205, 251` | `207, 93%, 79%` | `40%, 18%, 0%, 2%` |
| <img src="assets/palette/circles/sky.png" height="23" width="23"/> | Sky | `#89DCEB` | `137, 220, 235` | `189, 71%, 73%` | `42%, 6%, 0%, 8%` |
<img src="assets/misc/transparent.png" height="10" width="0" />
#### Night
| | Name | Hex | RGB | HSL | CMYK |
| ------------------------------------------------------------------------ | --------- | --------- | --------------- | ---------------- | ------------------- |
| <img src="assets/palette/circles/black0.png" height="23" width="23"/> | Black 0 | `#161320` | `22, 19, 32` | `254, 25%, 10%` | `31%, 41%, 0%, 87%` |
| <img src="assets/palette/circles/black1.png" height="23" width="23"/> | Black 1 | `#1A1826` | `26, 24, 38` | `249, 23%, 12%` | `32%, 37%, 0%, 85%` |
| <img src="assets/palette/circles/black2.png" height="23" width="23"/> | Black 2 | `#1E1E2E` | `30, 30, 46` | `240, 21%, 15%%` | `35%, 35%, 0%, 82%` |
| <img src="assets/palette/circles/black3.png" height="23" width="23"/> | Black 3 | `#302D41` | `48, 45, 65` | `249, 18%, 22%` | `26%, 31%, 0%, 75%` |
| <img src="assets/palette/circles/black4.png" height="23" width="23"/> | Black 4 | `#575268` | `87, 82, 104` | `254, 12%, 36%` | `16%, 21%, 0%, 59%` |
| <img src="assets/palette/circles/gray0.png" height="23" width="23"/> | Gray 0 | `#6E6C7E` | `110, 108, 126` | `247, 8%, 46%` | `13%, 14%, 0%, 51%` |
| <img src="assets/palette/circles/gray1.png" height="23" width="23"/> | Gray 1 | `#988BA2` | `152, 139, 162` | `274, 11%, 59%` | `6%, 14%, 0%, 36%` |
| <img src="assets/palette/circles/gray2.png" height="23" width="23"/> | Gray 2 | `#C3BAC6` | `195, 186, 198` | `285, 10%, 75%` | `2%, 6%, 0%, 22%` |
| <img src="assets/palette/circles/white.png" height="23" width="23"/> | White | `#D9E0EE` | `217, 224, 238` | `220, 38%, 89%` | `9%, 6%, 0%, 7%` |
| <img src="assets/palette/circles/lavender.png" height="23" width="23"/> | Lavender | `#C9CBFF` | `201, 203, 255` | `238, 100%, 89%` | `21%, 20%, 0%, 0%` |
| <img src="assets/palette/circles/rosewater.png" height="23" width="23"/> | Rosewater | `#F5E0DC` | `245, 224, 220` | `10, 56%, 91%` | `0%, 9%, 10%, 4%` |
&nbsp;
### 🪵 Ports and more!
Catppuccin is available for various apps and in different formats. Here is a list of them:
#### IDEs/DEs
- [NeoVim](https://github.com/catppuccin/nvim)
- [VSCode](https://github.com/catppuccin/vscode)
- [Sublime Text](https://github.com/catppuccin/sublime-text) (WIP)
- [Geany](https://github.com/catppuccin/geany)
#### Development
- [GitHub](https://github.com/catppuccin/github)
- [Palette](https://github.com/catppuccin/palette)
- [Wallpapers](https://github.com/catppuccin/wallpapers)
#### Terminals
- [Kitty](https://github.com/catppuccin/kitty)
- [Windows Terminal](https://github.com/catppuccin/windows-terminal)
- [Alacritty](https://github.com/catppuccin/alacritty)
- [Gnome-Terminal](https://github.com/catppuccin/gnome-terminal)
- [Terminator](https://github.com/catppuccin/terminator)
- [iTerm 2](https://github.com/catppuccin/iterm)
- [Tmux](https://github.com/catppuccin/tmux)
- [Termux](https://github.com/catppuccin/termux)
- [Urxvt](https://github.com/catppuccin/urxvt)
- [Konsole](https://github.com/catppuccin/konsole)
- [Zellij](https://github.com/catppuccin/zellij)
- [WezTerm](https://github.com/catppuccin/WezTerm)
- [Contour](https://github.com/catppuccin/contour)
- [ST](https://github.com/catppuccin/st)
#### Messaging
- [Revolt Chat](https://github.com/catppuccin/revolt)
- [Discord](https://github.com/catppuccin/discord)
- [Telegram](https://github.com/catppuccin/telegram)
- [Mailspring](https://github.com/catppuccin/mailspring)
#### Browsers
- [FireFox](https://github.com/catppuccin/firefox)
- [DuckDuckGo](https://github.com/catppuccin/duckduckgo)
- [Chrome](https://github.com/catppuccin/chrome)
- [Vimium](https://github.com/catppuccin/vimium)
#### Productivity
- [Obsidian](https://github.com/catppuccin/obsidian)
- [Zathura](https://github.com/catppuccin/zathura)
- [Monkeytype](https://github.com/catppuccin/monkeytype)
- [Micro](https://github.com/catppuccin/micro)
#### Shells
- [Fish](https://github.com/catppuccin/fish)
#### System
- [GTK](https://github.com/catppuccin/gtk)
- [KDE](https://github.com/catppuccin/kde)
- [Xresources](https://github.com/catppuccin/xresources)
- [Cava](https://github.com/catppuccin/cava)
- [Btop](https://github.com/catppuccin/btop)
- [Mako](https://github.com/catppuccin/mako)
- [Fcitx5](https://github.com/catppuccin/fcitx5)
- [GRUB](https://github.com/catppuccin/grub)
- [Plank](https://github.com/catppuccin/plank)
- [Papirus Icon Theme Folders](https://github.com/catppuccin/papirus-folders)
- [Mouse Cursors](https://github.com/catppuccin/cursors)
&nbsp;
### 👐 Contribute
See [CONTRIBUTING.md](https://github.com/catppuccin/catppuccin/blob/dev/CONTRIBUTING.md).
&nbsp;
### 📜 License
Catppuccin is released under the MIT license, which grants the following permissions:
- Commercial use
- Distribution
- Modification
- Private use
For more convoluted language, see the [LICENSE](https://github.com/catppuccin/catppuccin/blob/main/LICENSE).
&nbsp;
### ❤️ Gratitude
Thanks to the following tools developing this project is possible:
- [coolors.co](https://coolors.co/): A tool for creating and collecting color palettes.
- [InkScape](https://inkscape.org/): Free and open-source vector graphics editor.
- [colors_converter.asp](https://www.w3schools.com/colors/colors_converter.asp): Color format converter.
- [mdigi.tools](https://mdigi.tools/): Web based digital tools.
&nbsp;
<p align="center"><img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/footers/gray0_ctp_on_line.svg?sanitize=true" /></p>
<p align="center">Copyright &copy; 2021-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a>
<p align="center"><a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=302d41&colorB=c9cbff"/></a></p>
Reference in a new issue View git blame Copy permalink