a8f3170972 | ||
---|---|---|
LICENSE | ||
README.md |
README.md
😸 Catppuccin for AwesomeApp
Warm mid-tone dark theme to show off your vibrant self!
Gallery
Usage
- Clone this repository locally
- Open the app's settings
- Select
import theme
and browse to where you cloned Catppuccin - Select it
🙋 FAQ (optional)
- Q: "Where can I find the doc?"
A: Run
:help theme
TEMPLATE INSTRUCTIONS
Note: feel free to remove this section after reading it 😎
🐧 Usage
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 it leaves a small tag under the repos name that says "generated from ". To avoid this follow these instructions:
- Create the repo and leave it empty
- Add this template as a remote:
git remote add template git@github.com:catppuccin/template.git
- Pull from it:
git remote pull template
- Delete the remote:
git remote remove template
🤩 Style
- The name of the repo must be the simplest version of the app's name (e.g
nvim
instead ofNeoVim
) - Format repo description as "Catppuccin theme for AwesomeApp"
- Uppercase meta files (e.g.
README.md
) - Don't add health files (like
CODE_OF_CONDUCTS
orSUPPORT
), those are organization-wide files stored here. - Emojis are the way, feel free to use them as much as you want.