catppuccin-palette/README.md

45 lines
1.6 KiB
Markdown
Raw Normal View History

2021-11-07 04:16:09 +00:00
<p align="center">
2021-11-11 14:06:45 +00:00
<h2 align="center">😸 Catppuccin for AwesomeApp</h2>
2021-11-07 04:16:09 +00:00
</p>
2021-11-11 14:06:45 +00:00
<p align="center">Warm mid-tone dark theme to show off your vibrant self!</p>
2021-11-07 04:16:09 +00:00
## Gallery
2021-11-11 16:51:53 +00:00
> **Note:** 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.
2021-11-11 16:50:36 +00:00
2021-11-07 04:16:09 +00:00
## Usage
2021-11-11 14:06:45 +00:00
1. Clone this repository locally
2. Open the app's settings
3. Select `import theme` and browse to where you cloned Catppuccin
4. Select it
2021-11-07 04:16:09 +00:00
2021-11-11 14:06:45 +00:00
## 🙋 FAQ (optional)
2021-11-11 16:35:55 +00:00
- Q: **_"Where can I find the doc?"_**
A: Run `:help theme`
2021-11-11 14:06:45 +00:00
2021-11-11 16:35:55 +00:00
---
# TEMPLATE INSTRUCTIONS
> **Note:** feel free to remove this section after reading it 😎
## 🐧 Usage
2021-11-11 16:40:01 +00:00
There are this things on GitHub called "template repositories" which you can use as blueprints for a new repo. The problem with this is that they leave a _small_ tag under the repos' name that says "generated from <template>". To avoid this follow these instructions:
2021-11-11 14:06:45 +00:00
2021-11-11 16:35:55 +00:00
1. Create the repo and leave it empty
2. Add this template as a remote: `git remote add template git@github.com:catppuccin/template.git`
3. Pull from it: `git remote pull template`
4. Delete the remote: `git remote remove template`
## 🤩 Style
2021-11-07 04:21:37 +00:00
2021-11-07 04:16:09 +00:00
- The name of the repo must be the simplest version of the app's name (e.g `nvim` instead of `NeoVim`)
- Format repo description as "Catppuccin theme for AwesomeApp"
- Uppercase meta files (e.g. `README.md`)
2021-11-07 04:21:37 +00:00
- Don't add health files (like `CODE_OF_CONDUCTS` or `SUPPORT`), those are organization-wide files stored [here](https://github.com/catppuccin/.github).
2021-11-11 14:06:45 +00:00
- Emojis are _the way_, feel free to use them as much as you want.