1
0
mirror of https://github.com/catppuccin/misskey synced 2024-11-30 15:58:07 +09:00
catppuccin-misskey/README.md
2021-11-11 11:50:36 -05:00

1.6 KiB

😸 Catppuccin for AwesomeApp

Warm mid-tone dark theme to show off your vibrant self!

Note: put the images under assets/. If there are a bunch them consider creating an empty branch (e.g. assets) and storing them there.

Usage

  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

🙋 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 they leave a small tag under the repos' name that says "generated from ". To avoid this follow these instructions:

  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

  • 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)
  • Don't add health files (like CODE_OF_CONDUCTS or SUPPORT), those are organization-wide files stored here.
  • Emojis are the way, feel free to use them as much as you want.