From 00e5344b2b5a7bf504540395e47600a28312baad Mon Sep 17 00:00:00 2001 From: Pocco81 Date: Wed, 25 May 2022 12:13:35 -0500 Subject: [PATCH] added contributing --- README.md | 3 ++- docs/README.md | 6 +++++- docs/contributing.md | 39 +++++++++++++++++++++++++++++++++++++++ docs/integration.md | 0 docs/specs.md | 0 docs/style-guide.md | 10 ++++++++++ 6 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 docs/contributing.md create mode 100644 docs/integration.md create mode 100644 docs/specs.md create mode 100644 docs/style-guide.md diff --git a/README.md b/README.md index d759382..830cbc5 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,8 @@  

-Catppuccin is a community-driven pastel theme that aims to be the middle ground between low and high contrast themes. It consists of a soothing warm palette with 22 eye-candy colors 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. +

Discord Logo Github Logo Npm Logo diff --git a/docs/README.md b/docs/README.md index 68bde6a..4a4c822 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,11 +13,15 @@

- Documentation for Koy, the human-friendly data serialization language + Documentation for Catppuccin, the soothing pastel theme for the high-spirited!

  +

+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. +

+ ### 🎏 Koy Lang Koy is designed to be a minimal, simple and intuitive data serialization language; easy for you, your dog and your average 5 year-old. It has a small set of symbols, not too many rules and only one singular statement. Its lack of complexity makes it the perfect language for your project! easy to implement, debug and modularize. diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..e779a1d --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,39 @@ +

+

🤝 Contributing

+

+ +

+ Creating Catppuccin ports +

+ +  + +This section covers how to properly create Catppuccin ports and how to submit them! + +### 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! + +### 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