hammy
/
catppuccin
mirror of https://github.com/sgoudham/catppuccin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

added newlines

Browse Source
pull/1/head
Pocco81 3 years ago
parent 8e0f9f2651
commit af5373bbad
2 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File

10
docs/README.md
Unescape Escape View File

@ -16,12 +16,12 @@
Documentation for Catppuccin, the soothing pastel theme for the high-spirited! Documentation for Catppuccin, the soothing pastel theme for the high-spirited!
</p> </p>
&nbsp;
<p align="center"> <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 4 soothing warms palette with 26 eye-candy colors each, 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. Catppuccin is a community-driven pastel theme that aims to be the middle ground between low and high contrast themes. It consists of 4 soothing warms palette with 26 eye-candy colors each, 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> </p>
&nbsp;
### 🪴 Index ### 🪴 Index
+ [Library Implementations](#-library-implementations) + [Library Implementations](#-library-implementations)
@ -30,3 +30,9 @@ Catppuccin is a community-driven pastel theme that aims to be the middle ground
+ [ToDo List](#-todo-list) + [ToDo List](#-todo-list)
+ [FAQ](#-faq) + [FAQ](#-faq)
+ [License](#-license) + [License](#-license)
&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>

12
docs/contributing.md
Unescape Escape View File

@ -8,12 +8,12 @@
&nbsp; &nbsp;
This section covers how to properly create Catppuccin ports and how to submit them!
### What's a port? ### What's a port?
A port is basically an adaptation of Catppuccin's palettes for an app to use. Think of it as a colorscheme for a program that styles every UI component it consists of! A port is basically an adaptation of Catppuccin's palettes for an app to use. Think of it as a colorscheme for a program that styles every UI component it consists of!
&nbsp;
### Creation ### Creation
You can create ports using [this](https://github.com/catppuccin/template) public template as a blueprint. However, you must **not** create it the traditional way (by clicking **Use this template**), because this leaves a _small_ tag under the repos' name that says `generated from <template>`. To avoid this, follow the instructions below: You can create ports using [this](https://github.com/catppuccin/template) public template as a blueprint. However, you must **not** create it the traditional way (by clicking **Use this template**), because this leaves a _small_ tag under the repos' name that says `generated from <template>`. To avoid this, follow the instructions below:
@ -23,9 +23,11 @@ You can create ports using [this](https://github.com/catppuccin/template) public
3. Pull from it: `git pull template main --depth=1` 3. Pull from it: `git pull template main --depth=1`
4. Delete the remote: `git remote remove template` 4. Delete the remote: `git remote remove template`
&nbsp;
### Styling! ### Styling!
Although you just created the repo successfully, it's important to style properly to ensure consistency: Although you just created the repo successfully, it's important to style it properly to ensure consistency:
- The name of the repo must be the simplest version of the app's name (e.g `nvim` instead of `NeoVim`) - The name of the repo must be the simplest version of the app's name (e.g `nvim` instead of `NeoVim`)
- Put the images under `assets/`. If there are a bunch of them consider [creating an empty branch](https://gist.github.com/joncardasis/e6494afd538a400722545163eb2e1fa5) (e.g. `assets`) and storing them there. - Put the images under `assets/`. If there are a bunch of them consider [creating an empty branch](https://gist.github.com/joncardasis/e6494afd538a400722545163eb2e1fa5) (e.g. `assets`) and storing them there.
@ -34,6 +36,8 @@ Although you just created the repo successfully, it's important to style properl
- Ensure uppercase meta files (e.g. `README.md`) - Ensure uppercase meta files (e.g. `README.md`)
- Don't add health files (e.g. `CODE_OF_CONDUCTS.md`, `SUPPORT.md`), those are organization-wide files stored [here](https://github.com/catppuccin/.github). - Don't add health files (e.g. `CODE_OF_CONDUCTS.md`, `SUPPORT.md`), those are organization-wide files stored [here](https://github.com/catppuccin/.github).
#### Submission &nbsp;
### Submission
Open an issue under the main repo and fill out the information requested on the "[port request](https://github.com/catppuccin/catppuccin/issues/new?assignees=&labels=port+request&template=port-request.md&title=App)". It's recommended to also share the port in our [Discord server](https://discord.gg/r6Mdz5dpFc) beforehand so that other members of the community can give their opinion on it and hopefully improve it. Open an issue under the main repo and fill out the information requested on the "[port request](https://github.com/catppuccin/catppuccin/issues/new?assignees=&labels=port+request&template=port-request.md&title=App)". It's recommended to also share the port in our [Discord server](https://discord.gg/r6Mdz5dpFc) beforehand so that other members of the community can give their opinion on it and hopefully improve it.

Write Preview
Loading…
Cancel
Save