diff --git a/README.md b/README.md index 870ff88..70f7276 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@
- Luminance-corrected (LCH) highlighting for JetBrains IDEs. Updated regularly.
+ Poly highlights is a luminance-corrected (LCH) highlighting theme for JetBrains IDEs. It was created to enhance the readability and aesthetics of your code, making it easier to navigate and understand. Whether you're a seasoned developer or a beginner, Poly highlights is designed to improve your coding experience. Updated regularly.
- How to install.
+ Installation: To install Poly highlights, navigate to your IDE's settings and select the Poly highlights theme. For more detailed instructions, see the installation guide.
@@ -12,61 +12,58 @@
- -Hand crafted for clarity and focus. Using luminance-corrected colors for maximum confort. +Hand crafted for clarity and focus. Using luminance-corrected colors for maximum confort. Language defaults correctly applied, so you can extend it as you please Just use https://github.com/fabrizioschiavi/pragmatapro or https://github.com/be5invis/Iosevka if you prefer condensed fonts. -___ -Supported and tested languages: - -- Typescript -- Angular (language service) -- Javascript -- HTML -- CSS -- SCSS -- SASS -- Java -- Kotlin -- C# -- .NET - -# Design strategy -These have been generated in a LCH colorspace and then manually adjusted for their derivative colors. -| What | Color | Hex | Why | -|---------------- |-------- |-------- |----------------------------------------------- | -| Keyword | Blue | #4BA5FF | Base color | -| Class | Green | #70B844 | Easy to locate | -| Interface | Purple | #D28BD7 | Easy to locate | -| Variable/Field | Orange | #EB8443 | Less fatiguing color against dark backgrounds | -| Parameter | Yellow | #FFCA28 | Contrast with method body | -| String | White | #C3CEE3 | Contrast, neutral color | +--- -# Samples -Typescript|HTML| -:-------------------------:|:-------------------------: - |  +Supported and tested languages: +- Typescript: Poly highlights improves Typescript code readability by distinctly highlighting key elements. +- Angular (language service): Poly highlights improves navigation and understanding of Angular templates. +- Javascript: Poly highlights improves Javascript code comprehension by distinctly highlighting syntax and keywords. +- HTML: Poly highlights improves HTML code readability by distinctly highlighting tags and attributes. +- CSS, SCSS, SASS: Poly highlights improves CSS, SCSS, and SASS code readability by distinctly highlighting selectors, properties, and values. +- Java: Poly highlights enhances Java code comprehension by distinctly highlighting classes, methods, and variables. +- Kotlin: Poly highlights improves navigation and understanding of Kotlin code. +- C#, .NET: Poly highlights improves C# and .NET code comprehension by distinctly highlighting key elements. -SCSS|JSON| -:-------------------------:|:-------------------------: - |  +# Design strategy +These have been generated in a LCH colorspace and then manually adjusted for their derivative colors. The colors were chosen to maximize contrast and readability, while also being easy on the eyes. Here's a breakdown of the color choices: -JS|TS| -:-------------------------:|:-------------------------: - |  +| What | Color | Hex | Why | +| -------------- | ------ | ------- | ----------------------------------------------------------------------------- | +| Keyword | Blue | #4BA5FF | Base color, designed for clear distinction | +| Class | Green | #70B844 | Prominent against other elements, facilitating quick location | +| Interface | Purple | #D28BD7 | Distinct from classes, aiding in quick identification | +| Variable/Field | Orange | #EB8443 | Less fatiguing color against dark backgrounds, designed for clear distinction | +| Parameter | Yellow | #FFCA28 | Contrasts with method body, facilitating quick location | +| String | White | #C3CEE3 | Contrast, neutral color, easy to read | +# Samples +The following samples showcase how Poly highlights works with different languages and IDEs. Each color represents a different element of the code, making it easier to read and understand. -Angular Templates|.NET| -:-------------------------:|:-------------------------: -|  +| Typescript | HTML | +| :-------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: | +|  |  | +| SCSS | JSON | +| :-------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: | +|  |  | +| JS | TS | +| :-------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: | +|  |  | +| Angular Templates | .NET | +| :-------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: | +|  |  | +# Contributing +We welcome contributions to Poly highlights! If you have a suggestion, bug report, or want to add a new feature, please open an issue or submit a pull request. For more information, see the [contributing guide](./CONTRIBUTING.md).