catppuccin/README.md

75 lines
6.6 KiB
Markdown
Raw Normal View History

2021-11-06 21:57:56 +00:00
<p align="center">
<h2 align="center">🐱 Catppuccin!</h2>
</p>
<p align="center">Mid-tone dark theme for the masses!</p>
2021-11-06 22:00:16 +00:00
<p align="center">
2021-12-04 16:10:34 +00:00
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/morning.png" width="175" />
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/night.png" width="175" />
2021-11-06 22:05:32 +00:00
</p>
<p align="center">
2021-12-04 17:42:40 +00:00
<a href="https://github.com/catppuccin/catppuccin/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/catppuccin?colorA=1e1e28&colorB=a4b9ef&style=for-the-badge&logo=starship style=for-the-badge"></a>
2021-12-05 02:56:38 +00:00
<a href="https://github.com/catppuccin/catppuccin/releases/latest"><img src="https://img.shields.io/github/release/catppuccin/catppuccin.svg?&style=for-the-badge&label=Release&logo=github&logoColor=eceff4&colorA=1e1e28&colorB=f0afe1"/></a>
2021-12-04 17:18:34 +00:00
<a href="https://github.com/catppuccin/catppuccin/issues"><img src="https://img.shields.io/github/issues/catppuccin/catppuccin?colorA=1e1e28&colorB=f7c196&style=for-the-badge"></a>
2021-12-07 01:57:27 +00:00
<a href="https://discord.gg/r6Mdz5dpFc"><img src="https://img.shields.io/discord/907385605422448742?colorA=1e1e28&colorB=c6aae8&label=Discord&logo=discord&logoColor=white&style=for-the-badge"></a>
2021-11-06 22:00:16 +00:00
</p>
2021-11-06 22:26:38 +00:00
## About
2021-11-08 00:45:09 +00:00
<div style="text-align: justify">
2021-11-08 00:49:58 +00:00
Catppuccin is a community-driven mid-tone dark theme that aims to be the middle ground between low and high contrast themes, providing a warm color palette with 16 eye-candy colors that are bright enough to be visible during the day, yet pale enough to be easy on your eyes throughout the night. This repository tracks the development of the actual color palette, organization-wide assets, and general TODOs.
2021-11-08 00:45:09 +00:00
</div>
## 🎨 Palette
2021-11-06 22:30:52 +00:00
2021-12-04 17:21:12 +00:00
| | Hex | RGB | HSL | CMYK |
| ----------------------------------------------------------------------------------------------------------------------------------- | --------- | --------------- | --------------- | ------------------- |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/flamingo.png" height="23" width="23"/> | `#ECBFBD` | `236, 191, 189` | `3, 55%, 83%` | `0%, 19%, 20%, 7%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/magenta.png" height="23" width="23"/> | `#C6AAE8` | `198, 170, 232` | `267, 57%, 79%` | `15%, 27%, 0%, 9%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/pink.png" height="23" width="23"/> | `#F0AFE1` | `240, 175, 225` | `314, 68%, 81%` | `0%, 27%, 6%, 6%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/red.png" height="23" width="23"/> | `#E28C8C` | `226, 140, 140` | `0, 60%, 72%` | `0%, 38%, 38%, 11%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/peach.png" height="23" width="23"/> | `#F7C196` | `247, 193, 150` | `27, 86%, 78%` | `0%, 22%, 39%, 3%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/yellow.png" height="23" width="23"/> | `#EADDA0` | `234, 221, 160` | `49, 64%, 77%` | `0%, 6%, 32%, 8%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/green.png" height="23" width="23"/> | `#B3E1A3` | `179, 225, 163` | `105, 51%, 76%` | `20%, 0%, 28%, 12%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/blue.png" height="23" width="23"/> | `#A4B9EF` | `164, 185, 239` | `223, 70%, 79%` | `31%, 23%, 0%, 6%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/bkg1.png" height="23" width="23"/> | `#15121C` | `21, 18, 28` | `258, 22%, 9%` | `25%, 36%, 0%, 89%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/bkg2.png" height="23" width="23"/> | `#1B1923` | `27, 25, 35` | `252, 17%, 12%` | `23%, 29%, 0%, 86%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/bkg3.png" height="23" width="23"/> | `#1E1E28` | `30, 30, 40` | `240, 14%, 14%` | `25%, 25%, 0%, 84%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/bkg4.png" height="23" width="23"/> | `#2D293B` | `45, 41, 59` | `253, 18%, 20%` | `24%, 31%, 0%, 77%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/bkg5.png" height="23" width="23"/> | `#3E4058` | `62, 64, 88` | `235, 17%, 29%` | `30%, 27%, 0%, 65%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/gray.png" height="23" width="23"/> | `#6E6C7C` | `110, 108, 124` | `248, 7%, 45%` | `11%, 13%, 0%, 51%` |
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/white.png" height="23" width="23"/> | `#D7DAE0` | `215, 218, 224` | `220, 13%, 86%` | `4%, 3%, 0%, 12%` |
2021-12-08 01:18:19 +00:00
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/palette/circles/cyan.png" height="23" width="23"/> | `#9DDDCB` | `157, 221, 203` | `163, 48%, 74%` | `29%, 0%, 8%, 13%` |
2021-11-07 03:10:40 +00:00
2021-11-12 02:50:50 +00:00
## 🧠 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.
2021-11-07 03:37:47 +00:00
## 👐 Contribute
2021-11-07 03:32:08 +00:00
See [CONTRIBUTING.md](https://github.com/catppuccin/catppuccin/blob/dev/CONTRIBUTING.md).
2021-11-07 03:37:47 +00:00
## 📜 License
2021-11-07 03:32:08 +00:00
Catppuccin is released under the MIT license, which grants the following permissions:
2021-11-08 00:49:01 +00:00
- Commercial use
- Distribution
- Modification
- Private use
2021-11-07 03:32:08 +00:00
For more convoluted language, see the [LICENSE file](https://github.com/catppuccin/catppuccin/blob/main/LICENSE.md).
## 💝 Gratitude
2021-11-07 03:10:40 +00:00
Thanks to the following tools developing this project is possible:
2021-11-08 00:49:01 +00:00
- [coolors.co](https://coolors.co/): A tool for creating and collecting color palettes.
2021-11-08 01:09:44 +00:00
- [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.
2021-12-04 18:59:37 +00:00
- [mdigi.tools](https://mdigi.tools/): Web based digital tools.